org.jboss.shrinkwrap.resolver.api.maven

Class PackagingType

java.lang.Object

org.jboss.shrinkwrap.resolver.api.maven.PackagingType

public class PackagingType
extends Object

Represents the valid values for the "packaging" portion of a MavenCoordinate

Author:

Andrew Lee Rubinger, George Gastaldi

Field Summary

Fields

Modifier and Type	Field and Description
static PackagingType	EAR
static PackagingType	EJB
static PackagingType	EJB_CLIENT
static PackagingType	JAR
static PackagingType	JAVA_SOURCE
static PackagingType	JAVADOC
static PackagingType	MAVEN_PLUGIN
static PackagingType	PAR
static PackagingType	POM
static PackagingType	RAR
static PackagingType	TEST_JAR
static PackagingType	WAR

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static PackagingType	fromCache(String typeName) Returns a PackagingType object from cache.
String	getClassifier() Returns classifier for packaging.
String	getExtension() Returns extension for packaging.
String	getId() Returns type of the packaging.
int	hashCode()
static PackagingType	of(String typeName) Builds a PackagingType object.
String	toString() Returns the canonical String value of this PackagingType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

POM

public static final PackagingType POM

JAR

public static final PackagingType JAR

TEST_JAR

public static final PackagingType TEST_JAR

MAVEN_PLUGIN

public static final PackagingType MAVEN_PLUGIN

EJB_CLIENT

public static final PackagingType EJB_CLIENT

EJB

public static final PackagingType EJB

WAR

public static final PackagingType WAR

EAR

public static final PackagingType EAR

RAR

public static final PackagingType RAR

PAR

public static final PackagingType PAR

JAVADOC

public static final PackagingType JAVADOC

JAVA_SOURCE

public static final PackagingType JAVA_SOURCE

Method Detail

getId

public String getId()

Returns type of the packaging. Might be the same as extension.

Returns:

Type of the packaging.

getExtension

public String getExtension()

Returns extension for packaging. Might be the same as id;

Returns:

Extension for packaging.

getClassifier

public String getClassifier()

Returns classifier for packaging. Might be empty string.

Returns:

Classifier for packaging.

toString

public String toString()

Returns the canonical String value of this PackagingType

Overrides:

toString in class Object

of

public static PackagingType of(String typeName)
                        throws IllegalArgumentException

Builds a PackagingType object. If an appropriate object is not found in a cache, then a new one is created and registered into the cache.

Parameters:

typeName - String name of the packaging type

Returns:

Corresponding PackagingType object

Throws:

IllegalArgumentException - Thrown if typeName is null or empty

See Also:

fromCache(String)

fromCache

public static PackagingType fromCache(String typeName)
                               throws IllegalArgumentException

Returns a PackagingType object from cache. Objects registered into cache by default are:

         PackagingType POM = new PackagingType("pom");
         PackagingType JAR = new PackagingType("jar");
         PackagingType TEST_JAR = new PackagingType("test-jar", "jar", "tests");
         PackagingType MAVEN_PLUGIN = new PackagingType("maven-plugin", "jar", "");
         PackagingType EJB_CLIENT = new PackagingType("ejb-client", "jar", "client");
         PackagingType EJB = new PackagingType("ejb", "jar", "");
         PackagingType WAR = new PackagingType("war");
         PackagingType EAR = new PackagingType("ear");
         PackagingType RAR = new PackagingType("rar");
         PackagingType PAR = new PackagingType("par");
         PackagingType JAVADOC = new PackagingType("javadoc", "jar", "javadoc");
         PackagingType JAVA_SOURCE = new PackagingType("java-source", "jar", "sources");
 

Parameters:

typeName - String name of the packaging type

Returns:

Corresponding PackagingType object retrieved from cache, otherwise null

Throws:

IllegalArgumentException - Thrown if typeName is null or empty

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object