com.ihr.xbrl.om.lrr

Enum LrrRegistry.AttributeUse

java.lang.Object

java.lang.Enum<LrrRegistry.AttributeUse>

com.ihr.xbrl.om.lrr.LrrRegistry.AttributeUse

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LrrRegistry.AttributeUse>

Enclosing class:

LrrRegistry

public static enum LrrRegistry.AttributeUse
extends java.lang.Enum<LrrRegistry.AttributeUse>

{optional, required, prohibited} LRR definition of attribute uses.

Author:

Ignacio

Enum Constant Summary

Enum Constants

Enum Constant and Description
optional May or may not appear in the arc using the arc role.
prohibited Not usedful for arc arcroles but used to document sourceAbstract and targetAbstract elements.
required MUST be present in the arc using the arc role.

Method Summary

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

optional

public static final LrrRegistry.AttributeUse optional

May or may not appear in the arc using the arc role.

required

public static final LrrRegistry.AttributeUse required

MUST be present in the arc using the arc role. Shall be enforced by a specific element name including the attribute as part of the schema definition thought

prohibited

public static final LrrRegistry.AttributeUse prohibited

Not usedful for arc arcroles but used to document sourceAbstract and targetAbstract elements.

Method Detail

values

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

Returns:

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

valueOf

public static LrrRegistry.AttributeUse 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