org.jboss.shrinkwrap.resolver.spi.format

Interface FormatProcessor<RESOLVEDTYPE extends ResolvedArtifact<RESOLVEDTYPE>,RETURNTYPE>

Type Parameters:

RESOLVEDTYPE - The type to be processed

RETURNTYPE - The type to be returned Desired format to be returned from the ResolvedArtifact input in process(ResolvedArtifact, Class)

All Known Implementing Classes:

FileFormatProcessor, InputStreamFormatProcessor, URLFormatProcessor

public interface FormatProcessor<RESOLVEDTYPE extends ResolvedArtifact<RESOLVEDTYPE>,RETURNTYPE>

Processes an input ResolvedArtifact and returns as a typed format. Any format processor can be registered via SPI. See ServiceLoader for further details.

Author:

Andrew Lee Rubinger, Karel Piwko

Method Summary

Modifier and Type	Method and Description
boolean	handles(Class<?> resolvedTypeClass) Checks if the processor is able to process resolvedTypeClass
RETURNTYPE	process(RESOLVEDTYPE input, Class<RETURNTYPE> 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.

Method Detail

handles

boolean handles(Class<?> resolvedTypeClass)

Checks if the processor is able to process resolvedTypeClass

Parameters:

resolvedTypeClass - The type to be processed

Returns:

whether the processor is able to process resolvedTypeClass or not

returns

boolean returns(Class<?> returnTypeClass)

Checks if the processor is able to return returnTypeClass.

Parameters:

returnTypeClass - The type to be returned

Returns:

whether the processor is able to return returnTypeClass or not

process

RETURNTYPE process(RESOLVEDTYPE input,
                   Class<RETURNTYPE> returnType)
            throws IllegalArgumentException

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

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