Module dev.civl.sarl

Package dev.civl.sarl.IF.expr

Enum Class ReferenceExpression.ReferenceKind

java.lang.Object

java.lang.Enum<ReferenceExpression.ReferenceKind>

dev.civl.sarl.IF.expr.ReferenceExpression.ReferenceKind

All Implemented Interfaces:

Serializable, Comparable<ReferenceExpression.ReferenceKind>, Constable

Enclosing interface:

ReferenceExpression

public static enum ReferenceExpression.ReferenceKind
extends Enum<ReferenceExpression.ReferenceKind>

The different kinds of references.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARRAY_ELEMENT	An array element of reference.
IDENTITY	The identity reference.
NULL	The "null" reference.
OFFSET	An offset reference.
TUPLE_COMPONENT	A tuple component reference.
UNION_MEMBER	A union member reference.

Method Summary

Modifier and Type	Method	Description
static ReferenceExpression.ReferenceKind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ReferenceExpression.ReferenceKind[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NULL

public static final ReferenceExpression.ReferenceKind NULL

The "null" reference. This is a reference value that can never be dereferenced. Similar to C's NULL pointer.

IDENTITY

public static final ReferenceExpression.ReferenceKind IDENTITY

The identity reference. This is the reference that when applied to any value v, returns a reference to v.

ARRAY_ELEMENT

public static final ReferenceExpression.ReferenceKind ARRAY_ELEMENT

An array element of reference. A reference of this kind is an instance of ArrayElementReference. It includes a reference to the "parent" array and an index.

TUPLE_COMPONENT

public static final ReferenceExpression.ReferenceKind TUPLE_COMPONENT

A tuple component reference. A reference of this kind is an instance of TupleComponentReference. It includes a reference to the "parent" tuple value and a concrete integer field index.

UNION_MEMBER

public static final ReferenceExpression.ReferenceKind UNION_MEMBER

A union member reference. A reference of this kind is an instance of UnionMemberReference. It includes a reference to the "parent" union value and an integer member index.

OFFSET

public static final ReferenceExpression.ReferenceKind OFFSET

An offset reference. A reference of this kind is an instance of OffsetReference. It includes a reference to a "parent" value and an integer "offset".

Method Details

values

public static ReferenceExpression.ReferenceKind[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ReferenceExpression.ReferenceKind valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null