PluginPrefixRequest (Apache Maven 3.1.1 API)

All Known Implementing Classes:

DefaultPluginPrefixRequest
```
public interface PluginPrefixRequest
```
Collects settings required to resolve a plugin prefix.

Since:

3.0

Author:

Benjamin Bentmann

Method Summary

Methods
Modifier and Type	Method and Description
`List<String>`	`getPluginGroups()` Gets the list of group ids to scan for the plugin prefix.
`Model`	`getPom()` Gets the POM whose build plugins are to be scanned for the prefix.
`String`	`getPrefix()` Gets the prefix of the plugin.
`List<RemoteRepository>`	`getRepositories()` Gets the remote repositories to use.
`RepositorySystemSession`	`getRepositorySession()` Gets the session to use for repository access.
`PluginPrefixRequest`	`setPluginGroups(List<String> pluginGroups)` Sets the list of group ids to scan for the plugin prefix.
`PluginPrefixRequest`	`setPom(Model pom)` Sets the POM whose build plugins are to be scanned for the prefix.
`PluginPrefixRequest`	`setPrefix(String prefix)` Sets the prefix of the plugin.
`PluginPrefixRequest`	`setRepositories(List<RemoteRepository> repositories)` Sets the remote repositories to use.
`PluginPrefixRequest`	`setRepositorySession(RepositorySystemSession repositorySession)` Sets the session to use for repository access.

- Method Detail
  - getPrefix
```
String getPrefix()
```
    Gets the prefix of the plugin.
    
    Returns:
    The prefix of the plugin.
  - setPrefix
```
PluginPrefixRequest setPrefix(String prefix)
```
    Sets the prefix of the plugin.
    
    Parameters:
    prefix - The prefix of the plugin.
    
    Returns:
    This request, never null.
  - getPluginGroups
```
List<String> getPluginGroups()
```
    Gets the list of group ids to scan for the plugin prefix.
    
    Returns:
    The list of group ids to scan for the plugin prefix, never null.
  - setPluginGroups
```
PluginPrefixRequest setPluginGroups(List<String> pluginGroups)
```
    Sets the list of group ids to scan for the plugin prefix.
    
    Parameters:
    pluginGroups - The list of group ids to scan for the plugin prefix, may be null.
    
    Returns:
    This request, never null.
  - getPom
```
Model getPom()
```
    Gets the POM whose build plugins are to be scanned for the prefix.
    
    Returns:
    The POM whose build plugins are to be scanned for the prefix or null to only search the plugin repositories.
  - setPom
```
PluginPrefixRequest setPom(Model pom)
```
    Sets the POM whose build plugins are to be scanned for the prefix.
    
    Parameters:
    pom - The POM whose build plugins are to be scanned for the prefix, may be null to only search the plugin repositories.
    
    Returns:
    This request, never null.
  - getRepositories
```
List<RemoteRepository> getRepositories()
```
    Gets the remote repositories to use.
    
    Returns:
    The remote repositories to use, never null.
  - setRepositories
```
PluginPrefixRequest setRepositories(List<RemoteRepository> repositories)
```
    Sets the remote repositories to use. Note: When creating a request from a project, be sure to use the plugin repositories and not the regular project repositories.
    
    Parameters:
    repositories - The remote repositories to use.
    
    Returns:
    This request, never null.
  - getRepositorySession
```
RepositorySystemSession getRepositorySession()
```
    Gets the session to use for repository access.
    
    Returns:
    The repository session or null if not set.
  - setRepositorySession
```
PluginPrefixRequest setRepositorySession(RepositorySystemSession repositorySession)
```
    Sets the session to use for repository access.
    
    Parameters:
    repositorySession - The repository session to use.
    
    Returns:
    This request, never null.

Interface PluginPrefixRequest

Method Summary

Method Detail

getPrefix

setPrefix

getPluginGroups

setPluginGroups

getPom

setPom

getRepositories

setRepositories

getRepositorySession

setRepositorySession