org.jboss.shrinkwrap.api.formatter
Enum Formatters
java.lang.Object
java.lang.Enum<Formatters>
org.jboss.shrinkwrap.api.formatter.Formatters
- All Implemented Interfaces:
- Serializable, Comparable<Formatters>, Formatter
public enum Formatters
- extends Enum<Formatters>
- implements Formatter
Available pre-configured Formatter
instances
used in constructing a human-readable form
for a specified Archive
.
- Version:
- $Revision: $
- Author:
- ALR
Method Summary |
String |
format(Archive<?> archive)
Returns a formatted view of the specified archive |
static Formatters |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static Formatters[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared. |
VERBOSE
public static final Formatters VERBOSE
SIMPLE
public static final Formatters SIMPLE
values
public static Formatters[] 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 (Formatters c : Formatters.values())
System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in
the order they are declared
valueOf
public static Formatters valueOf(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:
IllegalArgumentException
- if this enum type has no constant
with the specified name
NullPointerException
- if the argument is null
format
public String format(Archive<?> archive)
throws IllegalArgumentException
- Returns a formatted view of the specified archive
- Specified by:
format
in interface Formatter
- Returns:
-
- Throws:
IllegalArgumentException
- If the archive is not specified- See Also:
Formatter.format(org.jboss.shrinkwrap.api.Archive)
Copyright © 2009 JBoss, a division of Red Hat, Inc.. All Rights Reserved.