Module dev.civl.sarl

Package dev.civl.sarl.IF.expr.valueSetReference

Enum Class ValueSetReference.VSReferenceKind

java.lang.Object

java.lang.Enum<ValueSetReference.VSReferenceKind>

dev.civl.sarl.IF.expr.valueSetReference.ValueSetReference.VSReferenceKind

All Implemented Interfaces:

Serializable, Comparable<ValueSetReference.VSReferenceKind>, Constable

Enclosing interface:

ValueSetReference

public static enum ValueSetReference.VSReferenceKind
extends Enum<ValueSetReference.VSReferenceKind>

The different kinds of reference set elements.

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.
ARRAY_SECTION	An reference to a "section" of an array.
IDENTITY	The identity 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 ValueSetReference.VSReferenceKind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ValueSetReference.VSReferenceKind[]	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

IDENTITY

public static final ValueSetReference.VSReferenceKind IDENTITY

The identity reference. This is the reference that when applied to any value v, returns a reference to v. A reference of this kind is an instance of VSIdentityReference.

ARRAY_ELEMENT

public static final ValueSetReference.VSReferenceKind ARRAY_ELEMENT

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

ARRAY_SECTION

public static final ValueSetReference.VSReferenceKind ARRAY_SECTION

An reference to a "section" of an array. A reference of this kind is an instance of VSArraySectionReference. It includes a reference to the "parent" value set, an inclusive lower index bound and an exclusive upper index bound of the section.

TUPLE_COMPONENT

public static final ValueSetReference.VSReferenceKind TUPLE_COMPONENT

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

UNION_MEMBER

public static final ValueSetReference.VSReferenceKind UNION_MEMBER

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

OFFSET

public static final ValueSetReference.VSReferenceKind OFFSET

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

Method Details

values

public static ValueSetReference.VSReferenceKind[] 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 ValueSetReference.VSReferenceKind 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