org.jboss.shrinkwrap.api.formatter

Enum SimpleFormatter

java.lang.Object

java.lang.Enum<SimpleFormatter>

org.jboss.shrinkwrap.api.formatter.SimpleFormatter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SimpleFormatter>, Formatter

 enum SimpleFormatter
extends java.lang.Enum<SimpleFormatter>
implements Formatter

Formatter implementation to provide a simple, one-line description of an Archive, including its name

Version:

$Revision: $

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ASSETS String used to denote assets in the formatted message

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(Archive<?> archive) Returns a formatted view of the specified archive
private int	getNumAssets(Archive<?> archive) Returns the number of assets on an Archive.
static SimpleFormatter	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SimpleFormatter[]	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 SimpleFormatter INSTANCE

Field Detail

ASSETS

private static final java.lang.String ASSETS

String used to denote assets in the formatted message

See Also:

Constant Field Values

Method Detail

values

public static SimpleFormatter[] 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 (SimpleFormatter c : SimpleFormatter.values())
    System.out.println(c);

Returns:

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

valueOf

public static SimpleFormatter valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

format

public java.lang.String format(Archive<?> archive)
                        throws java.lang.IllegalArgumentException

Description copied from interface: Formatter

Returns a formatted view of the specified archive

Specified by:

format in interface Formatter

Returns:

Throws:

java.lang.IllegalArgumentException - If the archive is not specified

getNumAssets

private int getNumAssets(Archive<?> archive)

Returns the number of assets on an Archive.

Parameters:

archive - the Archive from which we are goint to obtain the number of assets.

Returns:

the number of assets inside the archive