org.apache.maven.plugins.dependency.fromConfiguration.ArtifactItem Maven / Gradle / Ivy
package org.apache.maven.plugins.dependency.fromConfiguration;
/*
* 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.io.File;
import java.util.Objects;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.ArtifactUtils;
import org.apache.maven.plugins.dependency.utils.DependencyUtil;
import org.apache.maven.shared.transfer.dependencies.DependableCoordinate;
import org.codehaus.plexus.components.io.filemappers.FileMapper;
/**
* ArtifactItem represents information specified in the plugin configuration section for each artifact.
*
* @since 1.0
* @author Brian Fox
*/
public class ArtifactItem
implements DependableCoordinate
{
/**
* Group Id of Artifact
*
* @parameter
* @required
*/
private String groupId;
/**
* Name of Artifact
*
* @parameter
* @required
*/
private String artifactId;
/**
* Version of Artifact
*
* @parameter
*/
private String version = null;
/**
* Type of Artifact (War,Jar,etc)
*
* @parameter
* @required
*/
private String type = "jar";
/**
* Classifier for Artifact (tests,sources,etc)
*
* @parameter
*/
private String classifier;
/**
* Location to use for this Artifact. Overrides default location.
*
* @parameter
*/
private File outputDirectory;
/**
* Provides ability to change destination file name
*
* @parameter
*/
private String destFileName;
/**
* Force Overwrite..this is the one to set in pom
*/
private String overWrite;
/**
* Encoding of artifact. Overrides default encoding.
*
* @parameter
*/
private String encoding;
/**
*
*/
private boolean needsProcessing;
/**
* Artifact Item
*/
private Artifact artifact;
/**
* A comma separated list of file patterns to include when unpacking the artifact.
*/
private String includes;
/**
* A comma separated list of file patterns to exclude when unpacking the artifact.
*/
private String excludes;
/**
* {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no rewriting shall happen.
*
* @since 3.1.2
*
* @parameter
*/
private FileMapper[] fileMappers;
/**
* Default ctor.
*/
public ArtifactItem()
{
// default constructor
}
/**
* @param artifact {@link Artifact}
*/
public ArtifactItem( Artifact artifact )
{
this.setArtifact( artifact );
this.setArtifactId( artifact.getArtifactId() );
this.setClassifier( artifact.getClassifier() );
this.setGroupId( artifact.getGroupId() );
this.setType( artifact.getType() );
this.setVersion( artifact.getVersion() );
}
private String filterEmptyString( String in )
{
if ( "".equals( in ) )
{
return null;
}
return in;
}
/**
* @return Returns the artifactId.
*/
public String getArtifactId()
{
return artifactId;
}
/**
* @param theArtifact The artifactId to set.
*/
public void setArtifactId( String theArtifact )
{
this.artifactId = filterEmptyString( theArtifact );
}
/**
* @return Returns the groupId.
*/
public String getGroupId()
{
return groupId;
}
/**
* @param groupId The groupId to set.
*/
public void setGroupId( String groupId )
{
this.groupId = filterEmptyString( groupId );
}
/**
* @return Returns the type.
*/
public String getType()
{
return type;
}
/**
* @param type The type to set.
*/
public void setType( String type )
{
this.type = filterEmptyString( type );
}
/**
* @return Returns the version.
*/
public String getVersion()
{
return version;
}
/**
* @param version The version to set.
*/
public void setVersion( String version )
{
this.version = filterEmptyString( version );
}
/**
* @return Returns the base version.
*/
public String getBaseVersion()
{
return ArtifactUtils.toSnapshotVersion( version );
}
/**
* @return Classifier.
*/
public String getClassifier()
{
return classifier;
}
/**
* @param classifier Classifier.
*/
public void setClassifier( String classifier )
{
this.classifier = filterEmptyString( classifier );
}
@Override
public String toString()
{
if ( this.classifier == null )
{
return groupId + ":" + artifactId + ":" + Objects.toString( version, "?" ) + ":" + type;
}
else
{
return groupId + ":" + artifactId + ":" + classifier + ":" + Objects.toString( version, "?" ) + ":"
+ type;
}
}
/**
* @return Returns the location.
*/
public File getOutputDirectory()
{
return outputDirectory;
}
/**
* @param outputDirectory The outputDirectory to set.
*/
public void setOutputDirectory( File outputDirectory )
{
this.outputDirectory = outputDirectory;
}
/**
* @return Returns the location.
*/
public String getDestFileName()
{
return destFileName;
}
/**
* @param destFileName The destFileName to set.
*/
public void setDestFileName( String destFileName )
{
this.destFileName = filterEmptyString( destFileName );
}
/**
* @return Returns the needsProcessing.
*/
public boolean isNeedsProcessing()
{
return this.needsProcessing;
}
/**
* @param needsProcessing The needsProcessing to set.
*/
public void setNeedsProcessing( boolean needsProcessing )
{
this.needsProcessing = needsProcessing;
}
/**
* @return Returns the overWriteSnapshots.
*/
public String getOverWrite()
{
return this.overWrite;
}
/**
* @param overWrite The overWrite to set.
*/
public void setOverWrite( String overWrite )
{
this.overWrite = overWrite;
}
/**
* @return Returns the encoding.
* @since 3.0
*/
public String getEncoding()
{
return this.encoding;
}
/**
* @param encoding The encoding to set.
* @since 3.0
*/
public void setEncoding( String encoding )
{
this.encoding = encoding;
}
/**
* @return Returns the artifact.
*/
public Artifact getArtifact()
{
return this.artifact;
}
/**
* @param artifact The artifact to set.
*/
public void setArtifact( Artifact artifact )
{
this.artifact = artifact;
}
/**
* @return Returns a comma separated list of excluded items
*/
public String getExcludes()
{
return DependencyUtil.cleanToBeTokenizedString( this.excludes );
}
/**
* @param excludes A comma separated list of items to exclude i.e. **\/*.xml, **\/*.properties
*/
public void setExcludes( String excludes )
{
this.excludes = excludes;
}
/**
* @return Returns a comma separated list of included items
*/
public String getIncludes()
{
return DependencyUtil.cleanToBeTokenizedString( this.includes );
}
/**
* @param includes A comma separated list of items to include i.e. **\/*.xml, **\/*.properties
*/
public void setIncludes( String includes )
{
this.includes = includes;
}
/**
* @return {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no rewriting shall
* happen.
*
* @since 3.1.2
*/
public FileMapper[] getFileMappers()
{
return this.fileMappers;
}
/**
* @param fileMappers {@link FileMapper}s to be used for rewriting each target path, or {@code null} if no
* rewriting shall happen.
*
* @since 3.1.2
*/
public void setFileMappers( FileMapper[] fileMappers )
{
this.fileMappers = fileMappers;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy