eu.bandm.tools.dtd

Enum EntityRole

java.lang.Object

java.lang.Enum<EntityRole>

eu.bandm.tools.dtd.EntityRole

All Implemented Interfaces:

Serializable, Comparable<EntityRole>

public enum EntityRole
extends Enum<EntityRole>

Models the different roles (/syntactic positions) and combinations thereof, the expansion text of a "parameter entity" can be compatible with.

Mostly these are positions in attribute declarations, or as "INCLUDE/IGNORE" switch, OR as parts of element content models, but many of the entity bodies found in practice can (by their syntactic structure only) play more than one role. This list tries to list the "reasonable" combinations. An implementation as a power set of single roles would be more natural in priciple, but could not distinguish between "NTV" and "NTVs". The implications are as follows:

         N_V_ContentModel_IncIgn =) N_V_ContentModel 
         NT
         NTV => NTVs 
    

Enum Constant Summary

Enum Constants

Enum Constant and Description
ContentModel is definitely sub expression of a content model
CrUdE none of the above
IncIgn has been USED as an "ingore/include" switch.
N_V_ContentModel simple id, can be attribute name, attribute value, part of an enumeration type definition, or part of a content model
N_V_ContentModel_IncIgn like preceding, but additionally to be used for the selection "INCLUDE/IGNORE"
NT is definitely a sequence of attribute name and type
NTV is definitely a complete attribute definition
NTVs is definitely a sequence of more than one complete attribute definitions
T is definitely an attribute type, nothing else
T_or_ContentModel is part of an enumerated attribute type, or disjunction in a content model
TV is definitely sequence of attribute type and value
V is definitely attribute value

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	maybe_content

Method Summary

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

N_V_ContentModel

public static final EntityRole N_V_ContentModel

simple id, can be attribute name, attribute value, part of an enumeration type definition, or part of a content model

N_V_ContentModel_IncIgn

public static final EntityRole N_V_ContentModel_IncIgn

like preceding, but additionally to be used for the selection "INCLUDE/IGNORE"

NT

public static final EntityRole NT

is definitely a sequence of attribute name and type

NTV

public static final EntityRole NTV

is definitely a complete attribute definition

NTVs

public static final EntityRole NTVs

is definitely a sequence of more than one complete attribute definitions

T

public static final EntityRole T

is definitely an attribute type, nothing else

T_or_ContentModel

public static final EntityRole T_or_ContentModel

is part of an enumerated attribute type, or disjunction in a content model

TV

public static final EntityRole TV

is definitely sequence of attribute type and value

V

public static final EntityRole V

is definitely attribute value

ContentModel

public static final EntityRole ContentModel

is definitely sub expression of a content model

IncIgn

public static final EntityRole IncIgn

has been USED as an "ingore/include" switch. (This cannot be recognized without context.)

CrUdE

public static final EntityRole CrUdE

none of the above

Field Detail

maybe_content

protected boolean maybe_content

Method Detail

values

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

Returns:

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

valueOf

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

maybe_content

public boolean maybe_content()