Package org.apache.maven.plugins.dependency.fromConfiguration

Class ArtifactItem

  • All Implemented Interfaces:
    org.apache.maven.shared.transfer.dependencies.DependableCoordinate
    public class ArtifactItem
extends java.lang.Object
implements org.apache.maven.shared.transfer.dependencies.DependableCoordinate
    ArtifactItem represents information specified in the plugin configuration section for each artifact.
    Since:
    1.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.apache.maven.artifact.Artifact artifact
      Artifact Item.
      private java.lang.String artifactId
      Name of artifact.
      private java.lang.String classifier
      Classifier for artifact (tests, sources, etc.)
      private java.lang.String destFileName
      Provides ability to change destination file name.
      private java.lang.String encoding
      Encoding of artifact.
      private java.lang.String excludes
      A comma separated list of file patterns to exclude when unpacking the artifact.
      private org.codehaus.plexus.components.io.filemappers.FileMapper[] fileMappers
      FileMappers to be used for rewriting each target path, or null if no rewriting shall happen.
      private java.lang.String groupId
      Group ID of artifact.
      private java.lang.String includes
      A comma separated list of file patterns to include when unpacking the artifact.
      private boolean needsProcessing  
      private java.io.File outputDirectory
      Location to use for this artifact.
      private java.lang.String overWrite
      Force Overwrite.
      private java.lang.String type
      Type of artifact (War, Jar, etc.)
      private java.lang.String version
      Version of artifact.

    • Constructor Summary

      Constructors 
      Constructor Description
      ArtifactItem()
      Default constructor.
      ArtifactItem​(org.apache.maven.artifact.Artifact artifact)  

    • Field Detail

      • groupId

        @Parameter(required=true)
private java.lang.String groupId
        Group ID of artifact.

      • artifactId

        @Parameter(required=true)
private java.lang.String artifactId
        Name of artifact.

      • version

        @Parameter
private java.lang.String version
        Version of artifact.

      • type

        @Parameter(required=true)
private java.lang.String type
        Type of artifact (War, Jar, etc.)

      • classifier

        @Parameter
private java.lang.String classifier
        Classifier for artifact (tests, sources, etc.)

      • outputDirectory

        @Parameter
private java.io.File outputDirectory
        Location to use for this artifact. Overrides default location.

      • destFileName

        @Parameter
private java.lang.String destFileName
        Provides ability to change destination file name.

      • overWrite

        private java.lang.String overWrite
        Force Overwrite. This is the one to set in pom.

      • encoding

        @Parameter
private java.lang.String encoding
        Encoding of artifact. Overrides default encoding.

      • needsProcessing

        private boolean needsProcessing

      • artifact

        private org.apache.maven.artifact.Artifact artifact
        Artifact Item.

      • includes

        private java.lang.String includes
        A comma separated list of file patterns to include when unpacking the artifact.

      • excludes

        private java.lang.String excludes
        A comma separated list of file patterns to exclude when unpacking the artifact.

      • fileMappers

        @Parameter
private org.codehaus.plexus.components.io.filemappers.FileMapper[] fileMappers
        FileMappers to be used for rewriting each target path, or null if no rewriting shall happen.
        Since:
        3.1.2

    • Constructor Detail

      • ArtifactItem

        public ArtifactItem()
        Default constructor.

      • ArtifactItem

        public ArtifactItem​(org.apache.maven.artifact.Artifact artifact)
        Parameters:
        artifact - Artifact

    • Method Detail

      • filterEmptyString

        private java.lang.String filterEmptyString​(java.lang.String in)

      • getArtifactId

        public java.lang.String getArtifactId()
        Specified by:
        getArtifactId in interface org.apache.maven.shared.transfer.dependencies.DependableCoordinate
        Returns:
        returns the artifact ID

      • setArtifactId

        public void setArtifactId​(java.lang.String theArtifact)
        Parameters:
        theArtifact - the artifact ID to set

      • getGroupId

        public java.lang.String getGroupId()
        Specified by:
        getGroupId in interface org.apache.maven.shared.transfer.dependencies.DependableCoordinate
        Returns:
        returns the group ID

      • setGroupId

        public void setGroupId​(java.lang.String groupId)
        Parameters:
        groupId - the group ID to set

      • getType

        public java.lang.String getType()
        Specified by:
        getType in interface org.apache.maven.shared.transfer.dependencies.DependableCoordinate
        Returns:
        returns the type

      • setType

        public void setType​(java.lang.String type)
        Parameters:
        type - the type to set

      • getVersion

        public java.lang.String getVersion()
        Specified by:
        getVersion in interface org.apache.maven.shared.transfer.dependencies.DependableCoordinate
        Returns:
        returns the version

      • setVersion

        public void setVersion​(java.lang.String version)
        Parameters:
        version - the version to set

      • getBaseVersion

        public java.lang.String getBaseVersion()
        Returns:
        teturns the base version

      • getClassifier

        public java.lang.String getClassifier()
        Specified by:
        getClassifier in interface org.apache.maven.shared.transfer.dependencies.DependableCoordinate
        Returns:
        classifier

      • setClassifier

        public void setClassifier​(java.lang.String classifier)
        Parameters:
        classifier - classifier

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getOutputDirectory

        public java.io.File getOutputDirectory()
        Returns:
        returns the location

      • setOutputDirectory

        public void setOutputDirectory​(java.io.File outputDirectory)
        Parameters:
        outputDirectory - the outputDirectory to set

      • getDestFileName

        public java.lang.String getDestFileName()
        Returns:
        returns the location

      • setDestFileName

        public void setDestFileName​(java.lang.String destFileName)
        Parameters:
        destFileName - the destination file name to set

      • isNeedsProcessing

        public boolean isNeedsProcessing()
        Returns:
        returns the needsProcessing

      • setNeedsProcessing

        public void setNeedsProcessing​(boolean needsProcessing)
        Parameters:
        needsProcessing - the needsProcessing to set

      • getOverWrite

        public java.lang.String getOverWrite()
        Returns:
        teturns the overWriteSnapshots

      • setOverWrite

        public void setOverWrite​(java.lang.String overWrite)
        Parameters:
        overWrite - the overWrite to set

      • getEncoding

        public java.lang.String getEncoding()
        Returns:
        returns the encoding
        Since:
        3.0

      • setEncoding

        public void setEncoding​(java.lang.String encoding)
        Parameters:
        encoding - the encoding to set
        Since:
        3.0

      • getArtifact

        public org.apache.maven.artifact.Artifact getArtifact()
        Returns:
        returns the artifact

      • setArtifact

        public void setArtifact​(org.apache.maven.artifact.Artifact artifact)
        Parameters:
        artifact - the artifact to set

      • getExcludes

        public java.lang.String getExcludes()
        Returns:
        returns a comma separated list of excluded items

      • setExcludes

        public void setExcludes​(java.lang.String excludes)
        Parameters:
        excludes - a comma separated list of items to exclude; for example, **\/*.xml, **\/*.properties

      • getIncludes

        public java.lang.String getIncludes()
        Returns:
        returns a comma separated list of items to include

      • setIncludes

        public void setIncludes​(java.lang.String includes)
        Parameters:
        includes - comma separated list of items to include; for example, **\/*.xml, **\/*.properties

      • getFileMappers

        public org.codehaus.plexus.components.io.filemappers.FileMapper[] getFileMappers()
        Returns:
        FileMappers to be used for rewriting each target path, or null if no rewriting shall happen
        Since:
        3.1.2

      • setFileMappers

        public void setFileMappers​(org.codehaus.plexus.components.io.filemappers.FileMapper[] fileMappers)
        Parameters:
        fileMappers - FileMappers to be used for rewriting each target path, or null if no rewriting shall happen
        Since:
        3.1.2