org.htmlcleaner
Enum OptionalOutput

java.lang.Object
  java.lang.Enum<OptionalOutput>
      org.htmlcleaner.OptionalOutput

All Implemented Interfaces:

Serializable, Comparable<OptionalOutput>

public enum OptionalOutput
extends Enum<OptionalOutput>

Enum Constant Summary

alwaysOutput
Always outputed, if information is not supplied in the source a default is created.

omit
Never outputed even if supplied in the source.

preserve
outputed ONLY if supplied in the source.

Method Summary

static OptionalOutput	valueOf(String name) Returns the enum constant of this type with the specified name.
static OptionalOutput[]	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

omit

public static final OptionalOutput omit

Never outputed even if supplied in the source.

preserve

public static final OptionalOutput preserve

outputed ONLY if supplied in the source.

alwaysOutput

public static final OptionalOutput alwaysOutput

Always outputed, if information is not supplied in the source a default is created.

Method Detail

values

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

Returns:

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

valueOf

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