org.bimserver.models.ifc4

Enum Tristate

java.lang.Object

java.lang.Enum<Tristate>

org.bimserver.models.ifc4.Tristate

All Implemented Interfaces:

Serializable, Comparable<Tristate>, org.eclipse.emf.common.util.Enumerator

public enum Tristate
extends Enum<Tristate>
implements org.eclipse.emf.common.util.Enumerator

A representation of the literals of the enumeration 'Tristate', and utility methods for working with them.

See Also:

Ifc4Package.getTristate()

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE The 'FALSE' literal object.
TRUE The 'TRUE' literal object.
UNDEFINED The 'UNDEFINED' literal object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FALSE_VALUE The 'FALSE' literal value.
static int	TRUE_VALUE The 'TRUE' literal value.
static int	UNDEFINED_VALUE The 'UNDEFINED' literal value.
static List<Tristate>	VALUES A public read-only list of all the 'Tristate' enumerators.

Method Summary

Modifier and Type	Method and Description
static Tristate	get(int value) Returns the 'Tristate' literal with the specified integer value.
static Tristate	get(String literal) Returns the 'Tristate' literal with the specified literal value.
static Tristate	getByName(String name) Returns the 'Tristate' literal with the specified name.
String	getLiteral()
String	getName()
int	getValue()
String	toString() Returns the literal value of the enumerator, which is its string representation.
static Tristate	valueOf(String name) Returns the enum constant of this type with the specified name.
static Tristate[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRUE

public static final Tristate TRUE

The 'TRUE' literal object.

See Also:

TRUE_VALUE

FALSE

public static final Tristate FALSE

The 'FALSE' literal object.

See Also:

FALSE_VALUE

UNDEFINED

public static final Tristate UNDEFINED

The 'UNDEFINED' literal object.

See Also:

UNDEFINED_VALUE

Field Detail

TRUE_VALUE

public static final int TRUE_VALUE

The 'TRUE' literal value.

If the meaning of 'TRUE' literal object isn't clear, there really should be more of a description here...

See Also:

TRUE, Constant Field Values

FALSE_VALUE

public static final int FALSE_VALUE

The 'FALSE' literal value.

If the meaning of 'FALSE' literal object isn't clear, there really should be more of a description here...

See Also:

FALSE, Constant Field Values

UNDEFINED_VALUE

public static final int UNDEFINED_VALUE

The 'UNDEFINED' literal value.

If the meaning of 'UNDEFINED' literal object isn't clear, there really should be more of a description here...

See Also:

UNDEFINED, Constant Field Values

VALUES

public static final List<Tristate> VALUES

A public read-only list of all the 'Tristate' enumerators.

Method Detail

values

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

Returns:

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

valueOf

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

get

public static Tristate get(String literal)

Returns the 'Tristate' literal with the specified literal value.

Parameters:

literal - the literal.

Returns:

the matching enumerator or null.

getByName

public static Tristate getByName(String name)

Returns the 'Tristate' literal with the specified name.

Parameters:

name - the name.

Returns:

the matching enumerator or null.

get

public static Tristate get(int value)

Returns the 'Tristate' literal with the specified integer value.

Parameters:

value - the integer value.

Returns:

the matching enumerator or null.

getValue

public int getValue()

Specified by:

getValue in interface org.eclipse.emf.common.util.Enumerator

getName

public String getName()

Specified by:

getName in interface org.eclipse.emf.common.util.Enumerator

getLiteral

public String getLiteral()

Specified by:

getLiteral in interface org.eclipse.emf.common.util.Enumerator

toString

public String toString()

Returns the literal value of the enumerator, which is its string representation.

Overrides:

toString in class Enum<Tristate>