org.antlr.v4.runtime

Enum Dependents

java.lang.Object

java.lang.Enum<Dependents>

org.antlr.v4.runtime.Dependents

All Implemented Interfaces:

Serializable, Comparable<Dependents>

public enum Dependents
extends Enum<Dependents>

Author:

Sam Harwell

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANCESTORS The element is dependent upon the set of the specified rule's ancestors (the transitive closure of PARENTS rules).
CHILDREN The element is dependent upon the set of the specified rule's children (rules which it directly references).
DESCENDANTS The element is dependent upon the set of the specified rule's descendants (the transitive closure of CHILDREN rules).
FOLLOWING The element is dependent upon the set of the specified rule's following elements (rules which might start after the end of the specified rule while parsing).
FOLLOWING_SIBLINGS The element is dependent upon the set of the specified rule's following siblings (the union of CHILDREN of its PARENTS which appear after a reference to the rule).
PARENTS The element is dependent upon the set of the specified rule's parents (rules which directly reference it).
PRECEEDING The element is dependent upon the set of the specified rule's preceeding elements (rules which might end before the start of the specified rule while parsing).
PRECEEDING_SIBLINGS The element is dependent upon the set of the specified rule's preceeding siblings (the union of CHILDREN of its PARENTS which appear before a reference to the rule).
SELF The element is dependent upon the specified rule.
SIBLINGS The element is dependent upon the set of the specified rule's siblings (the union of CHILDREN of its PARENTS).

Method Summary

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

SELF

public static final Dependents SELF

The element is dependent upon the specified rule.

PARENTS

public static final Dependents PARENTS

The element is dependent upon the set of the specified rule's parents (rules which directly reference it).

CHILDREN

public static final Dependents CHILDREN

The element is dependent upon the set of the specified rule's children (rules which it directly references).

ANCESTORS

public static final Dependents ANCESTORS

The element is dependent upon the set of the specified rule's ancestors (the transitive closure of PARENTS rules).

DESCENDANTS

public static final Dependents DESCENDANTS

The element is dependent upon the set of the specified rule's descendants (the transitive closure of CHILDREN rules).

SIBLINGS

public static final Dependents SIBLINGS

The element is dependent upon the set of the specified rule's siblings (the union of CHILDREN of its PARENTS).

PRECEEDING_SIBLINGS

public static final Dependents PRECEEDING_SIBLINGS

The element is dependent upon the set of the specified rule's preceeding siblings (the union of CHILDREN of its PARENTS which appear before a reference to the rule).

FOLLOWING_SIBLINGS

public static final Dependents FOLLOWING_SIBLINGS

The element is dependent upon the set of the specified rule's following siblings (the union of CHILDREN of its PARENTS which appear after a reference to the rule).

PRECEEDING

public static final Dependents PRECEEDING

The element is dependent upon the set of the specified rule's preceeding elements (rules which might end before the start of the specified rule while parsing). This is calculated by taking the PRECEEDING_SIBLINGS of the rule and each of its ANCESTORS, along with the DESCENDANTS of those elements.

FOLLOWING

public static final Dependents FOLLOWING

The element is dependent upon the set of the specified rule's following elements (rules which might start after the end of the specified rule while parsing). This is calculated by taking the FOLLOWING_SIBLINGS of the rule and each of its ANCESTORS, along with the DESCENDANTS of those elements.

Method Detail

values

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

Returns:

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

valueOf

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