uk.ac.ed.ph.snuggletex.internal.util

Enum PropertyOptions

java.lang.Object

java.lang.Enum<PropertyOptions>

uk.ac.ed.ph.snuggletex.internal.util.PropertyOptions

All Implemented Interfaces:

Serializable, Comparable<PropertyOptions>

public enum PropertyOptions
extends Enum<PropertyOptions>

Enumerates the different options that can be used for outputting property values in ObjectUtilities.beanToString(Object). (This is copied from ph-commons-util.)

Version:

$Revision$

Author:

David McKain

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIDE_VALUE Value of property will be omitted, but property will be shown in toString() if non-null to indicate its presence.
IGNORE_PROPERTY Property should be left out completely from toString() results
SHOW_FULL The default option, this shows the property value in full glory, expanding Arrays and calling Object.toString() on Objects.

Method Summary

Modifier and Type	Method and Description
static PropertyOptions	valueOf(String name) Returns the enum constant of this type with the specified name.
static PropertyOptions[]	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

IGNORE_PROPERTY

public static final PropertyOptions IGNORE_PROPERTY

Property should be left out completely from toString() results

HIDE_VALUE

public static final PropertyOptions HIDE_VALUE

Value of property will be omitted, but property will be shown in toString() if non-null to indicate its presence.

SHOW_FULL

public static final PropertyOptions SHOW_FULL

The default option, this shows the property value in full glory, expanding Arrays and calling Object.toString() on Objects.

Method Detail

values

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

Returns:

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

valueOf

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