Class ScopeArtifactFilter
- java.lang.Object
-
- org.apache.maven.shared.artifact.filter.ScopeArtifactFilter
-
- All Implemented Interfaces:
ArtifactFilter
,StatisticsReportingArtifactFilter
public class ScopeArtifactFilter extends java.lang.Object implements ArtifactFilter, StatisticsReportingArtifactFilter
ArtifactFilter
implementation that selects artifacts based on their scopes.
-
-
Constructor Summary
Constructors Constructor Description ScopeArtifactFilter()
Constructor that is meant to be used with fine-grained manipulation to enable/disable specific scopes using the associated mutator methods.ScopeArtifactFilter(java.lang.String scope)
Constructor that uses the implied nature of Maven scopes to determine which artifacts to include.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
hasMissedCriteria()
boolean
include(Artifact artifact)
boolean
isIncludeCompileScope()
boolean
isIncludeProvidedScope()
boolean
isIncludeRuntimeScope()
boolean
isIncludeSystemScope()
boolean
isIncludeTestScope()
void
reportFilteredArtifacts(org.codehaus.plexus.logging.Logger logger)
void
reportMissedCriteria(org.codehaus.plexus.logging.Logger logger)
ScopeArtifactFilter
reset()
Reset hit counts and tracking of filtered artifacts, BUT NOT ENABLED SCOPES.ScopeArtifactFilter
setIncludeCompileScope(boolean pIncludeCompileScope)
ScopeArtifactFilter
setIncludeCompileScopeWithImplications(boolean enabled)
Manages the following scopes: system provided compileScopeArtifactFilter
setIncludeNullScope(boolean enable)
Determine whether artifacts that have a null scope are included or excluded.ScopeArtifactFilter
setIncludeProvidedScope(boolean pIncludeProvidedScope)
ScopeArtifactFilter
setIncludeRuntimeScope(boolean pIncludeRuntimeScope)
ScopeArtifactFilter
setIncludeRuntimeScopeWithImplications(boolean enabled)
Manages the following scopes: compile runtimeScopeArtifactFilter
setIncludeSystemScope(boolean pIncludeSystemScope)
ScopeArtifactFilter
setIncludeTestScope(boolean pIncludeTestScope)
ScopeArtifactFilter
setIncludeTestScopeWithImplications(boolean enabled)
Manages the following scopes: system provided compile runtime testjava.lang.String
toString()
-
-
-
Constructor Detail
-
ScopeArtifactFilter
public ScopeArtifactFilter()
Constructor that is meant to be used with fine-grained manipulation to enable/disable specific scopes using the associated mutator methods.
-
ScopeArtifactFilter
public ScopeArtifactFilter(java.lang.String scope)
Constructor that uses the implied nature of Maven scopes to determine which artifacts to include. For instance, 'test' scope implies compile, provided, and runtime, while 'runtime' scope implies only compile.- Parameters:
scope
- the scope
-
-
Method Detail
-
include
public boolean include(Artifact artifact)
- Specified by:
include
in interfaceArtifactFilter
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- Returns:
- Information converted to a string.
-
reportFilteredArtifacts
public void reportFilteredArtifacts(org.codehaus.plexus.logging.Logger logger)
- Specified by:
reportFilteredArtifacts
in interfaceStatisticsReportingArtifactFilter
- Parameters:
logger
- the logger
-
reportMissedCriteria
public void reportMissedCriteria(org.codehaus.plexus.logging.Logger logger)
- Specified by:
reportMissedCriteria
in interfaceStatisticsReportingArtifactFilter
- Parameters:
logger
- the logger
-
hasMissedCriteria
public boolean hasMissedCriteria()
- Specified by:
hasMissedCriteria
in interfaceStatisticsReportingArtifactFilter
- Returns:
true
if missed criteria;false
otherwise.
-
isIncludeCompileScope
public boolean isIncludeCompileScope()
- Returns:
includeCompileScope
-
setIncludeCompileScope
public ScopeArtifactFilter setIncludeCompileScope(boolean pIncludeCompileScope)
- Parameters:
pIncludeCompileScope
- true/false.- Returns:
ScopeArtifactFilter
-
isIncludeRuntimeScope
public boolean isIncludeRuntimeScope()
- Returns:
includeRuntimeScope
-
setIncludeRuntimeScope
public ScopeArtifactFilter setIncludeRuntimeScope(boolean pIncludeRuntimeScope)
- Parameters:
pIncludeRuntimeScope
- true/false- Returns:
ScopeArtifactFilter
-
isIncludeTestScope
public boolean isIncludeTestScope()
- Returns:
includeTestScope
-
setIncludeTestScope
public ScopeArtifactFilter setIncludeTestScope(boolean pIncludeTestScope)
- Parameters:
pIncludeTestScope
-includeTestScope
- Returns:
ScopeArtifactFilter
-
isIncludeProvidedScope
public boolean isIncludeProvidedScope()
- Returns:
includeProvidedScope
-
setIncludeProvidedScope
public ScopeArtifactFilter setIncludeProvidedScope(boolean pIncludeProvidedScope)
- Parameters:
pIncludeProvidedScope
- yes/no.- Returns:
ScopeArtifactFilter()
-
isIncludeSystemScope
public boolean isIncludeSystemScope()
- Returns:
includeSystemScope
-
setIncludeSystemScope
public ScopeArtifactFilter setIncludeSystemScope(boolean pIncludeSystemScope)
-
setIncludeCompileScopeWithImplications
public ScopeArtifactFilter setIncludeCompileScopeWithImplications(boolean enabled)
Manages the following scopes:- system
- provided
- compile
- Parameters:
enabled
- whether specified scopes should be included- Returns:
- this instance
-
setIncludeRuntimeScopeWithImplications
public ScopeArtifactFilter setIncludeRuntimeScopeWithImplications(boolean enabled)
Manages the following scopes:- compile
- runtime
- Parameters:
enabled
- whether specified scopes should be included- Returns:
- this instance
-
setIncludeTestScopeWithImplications
public ScopeArtifactFilter setIncludeTestScopeWithImplications(boolean enabled)
Manages the following scopes:- system
- provided
- compile
- runtime
- test
- Parameters:
enabled
- whether specified scopes should be included- Returns:
- this instance
-
setIncludeNullScope
public ScopeArtifactFilter setIncludeNullScope(boolean enable)
Determine whether artifacts that have a null scope are included or excluded.- Parameters:
enable
- whether null-scope should be included- Returns:
- this instance
-
reset
public ScopeArtifactFilter reset()
Reset hit counts and tracking of filtered artifacts, BUT NOT ENABLED SCOPES.- Returns:
- this instance
-
-