org.jboss.shrinkwrap.resolver.api.maven.archive
Interface MavenArchiveFormatStage

All Superinterfaces:

FormatStage, MavenFormatStage

public interface MavenArchiveFormatStage
extends MavenFormatStage

Represents the formatting stage of resolution in which the resolved archive is returned as a ShrinkWrap Archive

Author:

Andrew Lee Rubinger

Method Summary

<ARCHIVETYPE extends org.jboss.shrinkwrap.api.Archive<ARCHIVETYPE>> ARCHIVETYPE[]	as(Class<ARCHIVETYPE> type) Formats the resultant artifacts as an array of Archives.
<ARCHIVETYPE extends org.jboss.shrinkwrap.api.Archive<ARCHIVETYPE>> ARCHIVETYPE	asSingle(Class<ARCHIVETYPE> type) Formats the resultant artifact as an Archive; assumes a single artifact is returned from resolution.

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.maven.MavenFormatStage

as, asSingle

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.FormatStage

as, as, as, asSingle, asSingle, asSingle

Method Detail

as

<ARCHIVETYPE extends org.jboss.shrinkwrap.api.Archive<ARCHIVETYPE>> ARCHIVETYPE[] as(Class<ARCHIVETYPE> type)
                                                                       throws IllegalArgumentException

Formats the resultant artifacts as an array of Archives. If nothing matches resolution, an empty array will be returned.

Parameters:

type -

Returns:

Throws:

IllegalArgumentException - If the type is not specified

asSingle

<ARCHIVETYPE extends org.jboss.shrinkwrap.api.Archive<ARCHIVETYPE>> ARCHIVETYPE asSingle(Class<ARCHIVETYPE> type)
                                                                           throws IllegalArgumentException,
                                                                                  NonUniqueResultException,
                                                                                  NoResolvedResultException

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

Parameters:

type -

Returns:

Throws:

IllegalArgumentException - If the type is not specified

NonUniqueResultException - If the resolution resulted in more than one result

NoResolvedResultException - If the resolution did not yield any result