org.jboss.shrinkwrap.resolver.api

Interface FormatStage<RESOLVEDTYPE extends ResolvedArtifact<RESOLVEDTYPE>>

Type Parameters:

RESOLVEDTYPE - The resolved type

public interface FormatStage<RESOLVEDTYPE extends ResolvedArtifact<RESOLVEDTYPE>>

Represents the formatting stage of resolution in which the RESOLVEDTYPE is returned in the desired format. Supports extensible formats by registering a FormatProcessor with the SPI.

Author:

Andrew Lee Rubinger, Karel Piwko

Method Summary

Modifier and Type	Method and Description
<RETURNTYPE> RETURNTYPE[]	as(Class<RETURNTYPE> returnTypeClass) Formats the resultant artifacts as an array of types.
File[]	asFile() Formats the resultant artifacts as an array of Files
InputStream[]	asInputStream() Formats the resultant artifacts as an array of InputStreams.
<RETURNTYPE> List<RETURNTYPE>	asList(Class<RETURNTYPE> returnTypeClass) Formats the resultant artifacts as a list of types.
RESOLVEDTYPE[]	asResolvedArtifact() Formats the resultant artifacts as an array of RESOLVEDTYPE.
<RETURNTYPE> RETURNTYPE	asSingle(Class<RETURNTYPE> returnTypeClass) Formats the resultant artifact as a type; assumes a single artifact is returned from resolution.
File	asSingleFile() Formats the resultant artifact as a File; assumes a single artifact is returned from resolution.
InputStream	asSingleInputStream() Formats the resultant artifact as an InputStream; assumes a single artifact is returned from resolution.
RESOLVEDTYPE	asSingleResolvedArtifact() Formats the resultant artifact as RESOLVEDTYPE; assumes a single artifact is returned from resolution.

Method Detail

asFile

File[] asFile()

Formats the resultant artifacts as an array of Files

Returns:

The formatted resultant artifacts as an array of Files

asSingleFile

File asSingleFile()
           throws NonUniqueResultException,
                  NoResolvedResultException

Formats the resultant artifact as a File; assumes a single artifact is returned from resolution.

Returns:

The formatted resultant artifacts as a File

Throws:

NonUniqueResultException - If the resolution resulted in more than one result

NoResolvedResultException - If the resolution did not yield any result

asInputStream

InputStream[] asInputStream()

Formats the resultant artifacts as an array of InputStreams. It is a caller responsibility to close the streams afterwards.

Returns:

The formatted resultant artifacts as an array of InputStreams.

asSingleInputStream

InputStream asSingleInputStream()
                         throws NonUniqueResultException,
                                NoResolvedResultException

Formats the resultant artifact as an InputStream; assumes a single artifact is returned from resolution. It is a caller responsibility to close the stream afterwards.

Returns:

The formatted resultant artifacts as an InputStream.

Throws:

NonUniqueResultException - If the resolution resulted in more than one result

NoResolvedResultException - If the resolution did not yield any result

asResolvedArtifact

RESOLVEDTYPE[] asResolvedArtifact()

Formats the resultant artifacts as an array of RESOLVEDTYPE.

Returns:

The formatted resultant artifacts as an array of RESOLVEDTYPE.

asSingleResolvedArtifact

RESOLVEDTYPE asSingleResolvedArtifact()
                               throws NonUniqueResultException,
                                      NoResolvedResultException

Formats the resultant artifact as RESOLVEDTYPE; assumes a single artifact is returned from resolution.

Returns:

The formatted resultant artifacts as RESOLVEDTYPE.

Throws:

NonUniqueResultException - If the resolution resulted in more than one result

NoResolvedResultException - If the resolution did not yield any result

as

<RETURNTYPE> RETURNTYPE[] as(Class<RETURNTYPE> returnTypeClass)
                      throws IllegalArgumentException,
                             UnsupportedOperationException

Formats the resultant artifacts as an array of types. If nothing matches resolution, an empty array will be returned. Supports extensible formats by registering a FormatProcessor for given returnTypeClass.

Type Parameters:

RETURNTYPE - The return type

Parameters:

returnTypeClass - The return type class

Returns:

The formatted resultant artifacts as an array of types.

Throws:

IllegalArgumentException - If the type is not specified

UnsupportedOperationException - If the type is not supported *

asList

<RETURNTYPE> List<RETURNTYPE> asList(Class<RETURNTYPE> returnTypeClass)
                              throws IllegalArgumentException,
                                     UnsupportedOperationException

Formats the resultant artifacts as a list of types. If nothing matches resolution, an empty list will be returned. Supports extensible formats by registering a FormatProcessor for given returnTypeClass.

Type Parameters:

RETURNTYPE - The return type

Parameters:

returnTypeClass - The return type class

Returns:

The formatted resultant artifacts as a list of types.

Throws:

IllegalArgumentException - If the type is not specified

UnsupportedOperationException - If the type is not supported *

asSingle

<RETURNTYPE> RETURNTYPE asSingle(Class<RETURNTYPE> returnTypeClass)
                          throws IllegalArgumentException,
                                 UnsupportedOperationException,
                                 NonUniqueResultException,
                                 NoResolvedResultException

Formats the resultant artifact as a type; assumes a single artifact is returned from resolution. Supports extensible formats by registering a FormatProcessor for given returnTypeClass.

Type Parameters:

RETURNTYPE - The return type

Parameters:

returnTypeClass - The return type class

Returns:

The formatted resultant artifacts as a type.

Throws:

NonUniqueResultException - If the resolution resulted in more than one result

NoResolvedResultException - If the resolution did not yield any result

IllegalArgumentException - If the type is not specified

UnsupportedOperationException - If the type is not supported