com.ihr.xbrl.om.aspects

Enum Aspects.AspectCode

java.lang.Object

java.lang.Enum<Aspects.AspectCode>

com.ihr.xbrl.om.aspects.Aspects.AspectCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Aspects.AspectCode>

Enclosing class:

Aspects

public static enum Aspects.AspectCode
extends java.lang.Enum<Aspects.AspectCode>

Provides enumeration and bitmap of main aspect codes.

Author:

Ignacio

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETESCENARIO The completescenario.
COMPLETESEGMENT The completesegment.
CONCEPT The concept.
CONTEXT The complete context.
DIMENSION The dimension.
ENTITYIDENTIFIER The entityidentifier.
LOCATION The location.
NONE The none.
NONXDTSCENARIO The nonxdtscenario.
NONXDTSEGMENT The nonxdtsegment.
PERIOD The period.
UNIT The unit.
VALUE The value.

Method Summary

Modifier and Type	Method and Description
static Aspects.AspectCode	getAspectFromCode(int code) Gets the aspect from code when the code represents only one aspect.
int	getCode() Gets the code.
static Aspects.AspectCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Aspects.AspectCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final Aspects.AspectCode NONE

The none.

CONCEPT

public static final Aspects.AspectCode CONCEPT

The concept.

LOCATION

public static final Aspects.AspectCode LOCATION

The location.

UNIT

public static final Aspects.AspectCode UNIT

The unit.

ENTITYIDENTIFIER

public static final Aspects.AspectCode ENTITYIDENTIFIER

The entityidentifier.

PERIOD

public static final Aspects.AspectCode PERIOD

The period.

DIMENSION

public static final Aspects.AspectCode DIMENSION

The dimension.

COMPLETESEGMENT

public static final Aspects.AspectCode COMPLETESEGMENT

The completesegment.

NONXDTSEGMENT

public static final Aspects.AspectCode NONXDTSEGMENT

The nonxdtsegment.

COMPLETESCENARIO

public static final Aspects.AspectCode COMPLETESCENARIO

The completescenario.

NONXDTSCENARIO

public static final Aspects.AspectCode NONXDTSCENARIO

The nonxdtscenario.

VALUE

public static final Aspects.AspectCode VALUE

The value.

CONTEXT

public static final Aspects.AspectCode CONTEXT

The complete context.

Method Detail

values

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

Returns:

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

valueOf

public static Aspects.AspectCode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCode

public int getCode()

Gets the code.

Returns:

the code

getAspectFromCode

public static Aspects.AspectCode getAspectFromCode(int code)

Gets the aspect from code when the code represents only one aspect.

Parameters:

code - the code

Returns:

the aspect from code

Throws:

java.lang.RuntimeException - if the code parameter is not one statically defined in the CommonAspectRule class or is a combination of aspects