org.jboss.shrinkwrap.resolver.spi.format

Enum PathFormatProcessor

java.lang.Object

java.lang.Enum<PathFormatProcessor>

org.jboss.shrinkwrap.resolver.spi.format.PathFormatProcessor

All Implemented Interfaces:

Serializable, Comparable<PathFormatProcessor>, FormatProcessor

public enum PathFormatProcessor
extends Enum<PathFormatProcessor>
implements FormatProcessor

FormatProcessor implementation to return a Path from the provided ResolvedArtifact argument. Implementation note: This format processor does not use type parameters to be able to process any type inherited from ResolvedArtifact.

Author:

Gunnar Morling

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
boolean	handles(Class resolvedTypeClass) Checks if the processor is able to process resolvedTypeClass
Path	process(ResolvedArtifact input, Class returnType) Processes the specified RESOLVEDTYPE and returns as the typed return value.
boolean	returns(Class returnTypeClass) Checks if the processor is able to return returnTypeClass.
static PathFormatProcessor	valueOf(String name) Returns the enum constant of this type with the specified name.
static PathFormatProcessor[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final PathFormatProcessor INSTANCE

Method Detail

values

public static PathFormatProcessor[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PathFormatProcessor c : PathFormatProcessor.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PathFormatProcessor valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

handles

public boolean handles(Class resolvedTypeClass)

Description copied from interface: FormatProcessor

Checks if the processor is able to process resolvedTypeClass

Specified by:

handles in interface FormatProcessor

Parameters:

resolvedTypeClass - The type to be processed

Returns:

whether the processor is able to process resolvedTypeClass or not

returns

public boolean returns(Class returnTypeClass)

Description copied from interface: FormatProcessor

Checks if the processor is able to return returnTypeClass.

Specified by:

returns in interface FormatProcessor

Parameters:

returnTypeClass - The type to be returned

Returns:

whether the processor is able to return returnTypeClass or not

process

public Path process(ResolvedArtifact input,
                    Class returnType)
             throws IllegalArgumentException

Description copied from interface: FormatProcessor

Processes the specified RESOLVEDTYPE and returns as the typed return value.

Specified by:

process in interface FormatProcessor

Parameters:

input - The type to be processed

returnType - The type to be returned

Returns:

The typed return value.

Throws:

IllegalArgumentException - If the RESOLVEDTYPE argument is not specified or null