ShrinkWrap Resolver API 2.0.0-alpha-3

org.jboss.shrinkwrap.resolver.api.formatprocessor
Enum FileFormatProcessor

java.lang.Object
  extended by java.lang.Enum<FileFormatProcessor>
      extended by org.jboss.shrinkwrap.resolver.api.formatprocessor.FileFormatProcessor
All Implemented Interfaces:
Serializable, Comparable<FileFormatProcessor>, FormatProcessor<File>

public enum FileFormatProcessor
extends Enum<FileFormatProcessor>
implements FormatProcessor<File>

FormatProcessor implementation to return a File as-is, assuming it exists and does not point to a directory.

Author:
Andrew Lee Rubinger

Enum Constant Summary
INSTANCE
           
 
Method Summary
 File process(File input)
          Processes the specified File and returns as the typed return value.
static FileFormatProcessor valueOf(String name)
          Returns the enum constant of this type with the specified name.
static FileFormatProcessor[] 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 FileFormatProcessor INSTANCE
Method Detail

values

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

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

valueOf

public static FileFormatProcessor 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

process

public File process(File input)
             throws IllegalArgumentException
Processes the specified File and returns as the typed return value.

Specified by:
process in interface FormatProcessor<File>
Returns:
Throws:
IllegalArgumentException - If the File argument is not specified, does not exist, or points to a directory
See Also:
FormatProcessor.process(java.io.File)

ShrinkWrap Resolver API 2.0.0-alpha-3

Copyright © 2012 JBoss by Red Hat. All Rights Reserved.