org.wso2.maven.p2.beans

Class CarbonArtifact

java.lang.Object

org.wso2.maven.p2.beans.CarbonArtifact

Direct Known Subclasses:

Bundle, Bundle, Feature, Feature

public class CarbonArtifact
extends Object

Bean class representing CarbonArtifacts.

This class is extended by all the Bean classes which represent any artifact created from the carbon feature plugin.

Since:

2.0.0

Constructor Summary

Constructors

Constructor and Description
CarbonArtifact()

Method Summary

Modifier and Type	Method and Description
<T extends CarbonArtifact> void	copyTo(T item) Util method which will copy some of the properties of this parent class into it's sub classes.
org.apache.maven.artifact.Artifact	getArtifact() Returns the actual maven artifact represented by this carbon artifact
String	getArtifactId() Returns the maven artifact id for the carbon artifact.
String	getBundleVersion() Returns the OSGI bundle version of the actual artifact represented by this carbon artifact.
String	getCompatibility() Returns the compatibility type of this CarbonArtifact.
String	getGroupId() Returns the maven group id for the carbon artifact.
String	getSymbolicName() Returns the OSGI symbolic name which is in the manifest file of the artifact represented by this carbon artifact.
String	getType() Returns the file type of the actual artifact represented by this carbon artifact.
String	getVersion() Returns the maven version for this artifact.
void	setArtifact(org.apache.maven.artifact.Artifact artifact) Sets the actual maven artifact represented by this carbon artifact
void	setArtifactId(String artifactId) Sets the maven artifact id for the carbon artifact.
void	setBundleVersion(String bundleVersion) Sets the OSGI bundle version of the actual artifact represented by this carbon artifact.
void	setCompatibility(String compatibility)
void	setGroupId(String groupId) Sets the maven group id for the carbon artifact.
void	setSymbolicName(String symbolicName) Sets the OSGI symbolic name which is in the manifest file of the artifact represented by this carbon artifact.
void	setType(String type) Sets the file type(extension) of the actual artifact represented by this carbon artifact.
void	setVersion(String version) Sets the maven version for this artifact.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CarbonArtifact

public CarbonArtifact()

Method Detail

getGroupId

public String getGroupId()

Returns the maven group id for the carbon artifact.

Returns:

String

setGroupId

public void setGroupId(String groupId)

Sets the maven group id for the carbon artifact.

Parameters:

groupId - String

getArtifactId

public String getArtifactId()

Returns the maven artifact id for the carbon artifact.

Returns:

String

setArtifactId

public void setArtifactId(String artifactId)

Sets the maven artifact id for the carbon artifact.

Parameters:

artifactId - String

getVersion

public String getVersion()

Returns the maven version for this artifact.

Important: This is not the OSGI version

Returns:

String

setVersion

public void setVersion(String version)

Sets the maven version for this artifact.

Important: This is not the OSGI version

Parameters:

version - String

getArtifact

public org.apache.maven.artifact.Artifact getArtifact()

Returns the actual maven artifact represented by this carbon artifact

Returns:

org.apache.maven.artifact object

setArtifact

public void setArtifact(org.apache.maven.artifact.Artifact artifact)

Sets the actual maven artifact represented by this carbon artifact

Parameters:

artifact - org.apache.maven.artifact object

getSymbolicName

public String getSymbolicName()

Returns the OSGI symbolic name which is in the manifest file of the artifact represented by this carbon artifact. This is applicable only if the represented carbon artifact is an OSGI bundle.

Returns:

String symbolic name

setSymbolicName

public void setSymbolicName(String symbolicName)

Sets the OSGI symbolic name which is in the manifest file of the artifact represented by this carbon artifact. This is applicable only if the represented carbon artifact is an OSGI bundle.

Parameters:

symbolicName - String

getType

public String getType()

Returns the file type of the actual artifact represented by this carbon artifact. i.e: Jar, Zip

Returns:

String file extension

setType

public void setType(String type)

Sets the file type(extension) of the actual artifact represented by this carbon artifact.

Parameters:

type - String

getBundleVersion

public String getBundleVersion()

Returns the OSGI bundle version of the actual artifact represented by this carbon artifact. This is applicable only if the carbon artifact represent an OSGI bundle.

Returns:

String

setBundleVersion

public void setBundleVersion(String bundleVersion)

Sets the OSGI bundle version of the actual artifact represented by this carbon artifact. This is applicable only if the carbon artifact represent an OSGI bundle.

Parameters:

bundleVersion - String

getCompatibility

public String getCompatibility()

Returns the compatibility type of this CarbonArtifact. Permitted values are;

• perfect
• equivalent
• compatible
• greaterOrEqual
• patch
• optional

Returns:

String compatibility

setCompatibility

public void setCompatibility(String compatibility)

copyTo

public <T extends CarbonArtifact> void copyTo(T item)

Util method which will copy some of the properties of this parent class into it's sub classes.

Type Parameters:

T - SubClass of CarbonArtifact

Parameters:

item - target Subclass of CarbonArtifact object which needs to copy fields of this object.