aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/maven/apache-maven-3.3.3/maven-core/src/main/java/org/apache/maven/plugin/prefix/PluginPrefixRequest.java
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/maven/apache-maven-3.3.3/maven-core/src/main/java/org/apache/maven/plugin/prefix/PluginPrefixRequest.java')
-rw-r--r--framework/src/maven/apache-maven-3.3.3/maven-core/src/main/java/org/apache/maven/plugin/prefix/PluginPrefixRequest.java115
1 files changed, 115 insertions, 0 deletions
diff --git a/framework/src/maven/apache-maven-3.3.3/maven-core/src/main/java/org/apache/maven/plugin/prefix/PluginPrefixRequest.java b/framework/src/maven/apache-maven-3.3.3/maven-core/src/main/java/org/apache/maven/plugin/prefix/PluginPrefixRequest.java
new file mode 100644
index 00000000..23df66ee
--- /dev/null
+++ b/framework/src/maven/apache-maven-3.3.3/maven-core/src/main/java/org/apache/maven/plugin/prefix/PluginPrefixRequest.java
@@ -0,0 +1,115 @@
+package org.apache.maven.plugin.prefix;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import java.util.List;
+
+import org.apache.maven.model.Model;
+import org.eclipse.aether.RepositorySystemSession;
+import org.eclipse.aether.repository.RemoteRepository;
+
+/**
+ * Collects settings required to resolve a plugin prefix.
+ *
+ * @since 3.0
+ * @author Benjamin Bentmann
+ */
+public interface PluginPrefixRequest
+{
+
+ /**
+ * Gets the prefix of the plugin.
+ *
+ * @return The prefix of the plugin.
+ */
+ String getPrefix();
+
+ /**
+ * Sets the prefix of the plugin.
+ *
+ * @param prefix The prefix of the plugin.
+ * @return This request, never {@code null}.
+ */
+ PluginPrefixRequest setPrefix( String prefix );
+
+ /**
+ * Gets the list of group ids to scan for the plugin prefix.
+ *
+ * @return The list of group ids to scan for the plugin prefix, never {@code null}.
+ */
+ List<String> getPluginGroups();
+
+ /**
+ * Sets the list of group ids to scan for the plugin prefix.
+ *
+ * @param pluginGroups The list of group ids to scan for the plugin prefix, may be {@code null}.
+ * @return This request, never {@code null}.
+ */
+ PluginPrefixRequest setPluginGroups( List<String> pluginGroups );
+
+ /**
+ * Gets the POM whose build plugins are to be scanned for the prefix.
+ *
+ * @return The POM whose build plugins are to be scanned for the prefix or {@code null} to only search the plugin
+ * repositories.
+ */
+ Model getPom();
+
+ /**
+ * Sets the POM whose build plugins are to be scanned for the prefix.
+ *
+ * @param pom The POM whose build plugins are to be scanned for the prefix, may be {@code null} to only search the
+ * plugin repositories.
+ * @return This request, never {@code null}.
+ */
+ PluginPrefixRequest setPom( Model pom );
+
+ /**
+ * Gets the remote repositories to use.
+ *
+ * @return The remote repositories to use, never {@code null}.
+ */
+ List<RemoteRepository> getRepositories();
+
+ /**
+ * Sets the remote repositories to use. <em>Note:</em> When creating a request from a project, be sure to use the
+ * plugin repositories and not the regular project repositories.
+ *
+ * @param repositories The remote repositories to use.
+ * @return This request, never {@code null}.
+ */
+ PluginPrefixRequest setRepositories( List<RemoteRepository> repositories );
+
+ /**
+ * Gets the session to use for repository access.
+ *
+ * @return The repository session or {@code null} if not set.
+ */
+ RepositorySystemSession getRepositorySession();
+
+ /**
+ * Sets the session to use for repository access.
+ *
+ * @param repositorySession The repository session to use.
+ * @return This request, never {@code null}.
+ */
+ PluginPrefixRequest setRepositorySession( RepositorySystemSession repositorySession );
+
+}