org.jboss.shrinkwrap.api.formatter
Enum VerboseFormatter

java.lang.Object
  extended by java.lang.Enum<VerboseFormatter>
      extended by org.jboss.shrinkwrap.api.formatter.VerboseFormatter
All Implemented Interfaces:
Serializable, Comparable<VerboseFormatter>, Formatter

public enum VerboseFormatter
extends Enum<VerboseFormatter>
implements Formatter

Formatter implementation to provide an "ls -l"-esque output for an Archive, listing all internal contents in sorted order

Version:
$Revision: $
Author:
ALR

Enum Constant Summary
INSTANCE
           
 
Method Summary
 String format(Archive<?> archive)
          Returns a formatted view of the specified archive
static VerboseFormatter valueOf(String name)
          Returns the enum constant of this type with the specified name.
static VerboseFormatter[] 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 VerboseFormatter INSTANCE
Method Detail

values

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

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

valueOf

public static VerboseFormatter 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
Description copied from interface: Formatter
Returns a formatted view of the specified archive

Specified by:
format in interface Formatter
Returns:
Throws:
IllegalArgumentException - If the archive is not specified


Copyright © 2009 JBoss, a division of Red Hat, Inc.. All Rights Reserved.