org.jboss.shrinkwrap.resolver.impl.maven

Class MavenFormatStageImpl

java.lang.Object

org.jboss.shrinkwrap.resolver.impl.maven.MavenFormatStageImpl

All Implemented Interfaces:

FormatStage<MavenResolvedArtifact>, MavenFormatStage

public class MavenFormatStageImpl
extends Object
implements MavenFormatStage

Implementation of MavenFormatStage

Author:

Karel Piwko

Constructor Summary

Constructors

Constructor and Description
MavenFormatStageImpl(Collection<MavenResolvedArtifact> artifacts)

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.
MavenResolvedArtifact[]	asResolvedArtifact() Formats the resultant artifacts as an array of RESOLVEDTYPE.
<RETURNTYPE> RETURNTYPE	asSingle(Class<RETURNTYPE> type) 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.
MavenResolvedArtifact	asSingleResolvedArtifact() Formats the resultant artifact as RESOLVEDTYPE; assumes a single artifact is returned from resolution.

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenFormatStageImpl

public MavenFormatStageImpl(Collection<MavenResolvedArtifact> artifacts)

Method Detail

asFile

public File[] asFile()

Description copied from interface: FormatStage

Formats the resultant artifacts as an array of Files

Specified by:

asFile in interface FormatStage<MavenResolvedArtifact>

Returns:

The formatted resultant artifacts as an array of Files

asSingleFile

public File asSingleFile()
                  throws NonUniqueResultException,
                         NoResolvedResultException

Description copied from interface: FormatStage

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

Specified by:

asSingleFile in interface FormatStage<MavenResolvedArtifact>

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

public InputStream[] asInputStream()

Description copied from interface: FormatStage

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

Specified by:

asInputStream in interface FormatStage<MavenResolvedArtifact>

Returns:

The formatted resultant artifacts as an array of InputStreams.

asSingleInputStream

public InputStream asSingleInputStream()
                                throws NonUniqueResultException,
                                       NoResolvedResultException

Description copied from interface: FormatStage

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.

Specified by:

asSingleInputStream in interface FormatStage<MavenResolvedArtifact>

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

public MavenResolvedArtifact[] asResolvedArtifact()

Description copied from interface: FormatStage

Formats the resultant artifacts as an array of RESOLVEDTYPE.

Specified by:

asResolvedArtifact in interface FormatStage<MavenResolvedArtifact>

Returns:

The formatted resultant artifacts as an array of RESOLVEDTYPE.

asSingleResolvedArtifact

public MavenResolvedArtifact asSingleResolvedArtifact()
                                               throws NonUniqueResultException,
                                                      NoResolvedResultException

Description copied from interface: FormatStage

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

Specified by:

asSingleResolvedArtifact in interface FormatStage<MavenResolvedArtifact>

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

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

Description copied from interface: FormatStage

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.

Specified by:

as in interface FormatStage<MavenResolvedArtifact>

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

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

Description copied from interface: FormatStage

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.

Specified by:

asList in interface FormatStage<MavenResolvedArtifact>

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

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

Description copied from interface: FormatStage

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.

Specified by:

asSingle in interface FormatStage<MavenResolvedArtifact>

Type Parameters:

RETURNTYPE - The return type

Parameters:

type - The return type class

Returns:

The formatted resultant artifacts as a type.

Throws:

IllegalArgumentException - If the type is not specified

UnsupportedOperationException - If the type is not supported

NonUniqueResultException - If the resolution resulted in more than one result

NoResolvedResultException - If the resolution did not yield any result