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: $
  • Enum Constant Details

    • VERBOSE

      public static final Formatters VERBOSE
      Formatter implementation to provide an "ls -l"-esque output for an Archive, listing all internal contents in sorted order.
    • SIMPLE

      public static final Formatters SIMPLE
      Formatter implementation to provide a simple, one-line description of an Archive, including its name.
  • Field Details

  • Constructor Details

  • Method Details

    • values

      public static Formatters[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      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
      Parameters:
      archive -
      Returns:
      Throws:
      IllegalArgumentException - If the archive is not specified
      See Also: