Module dev.civl.abc

Package dev.civl.abc.ast.entity.IF

Enum Class Scope.ScopeKind

java.lang.Object

java.lang.Enum<Scope.ScopeKind>

dev.civl.abc.ast.entity.IF.Scope.ScopeKind

All Implemented Interfaces:

Serializable, Comparable<Scope.ScopeKind>, Constable

Enclosing interface:

Scope

public static enum Scope.ScopeKind
extends Enum<Scope.ScopeKind>

The different kinds of scopes: file, block, function, function-prototype, and contract.

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
BLOCK	A block scope.
CONTRACT	The scope for a CIVL-C contract.
FILE	File scope.
FUNCTION	A function scope.
FUNCTION_PROTOTYPE	A function prototype scope.

Method Summary

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

FILE

public static final Scope.ScopeKind FILE

File scope. This is the root scope.

BLOCK

public static final Scope.ScopeKind BLOCK

A block scope.

FUNCTION

public static final Scope.ScopeKind FUNCTION

A function scope.

FUNCTION_PROTOTYPE

public static final Scope.ScopeKind FUNCTION_PROTOTYPE

A function prototype scope.

CONTRACT

public static final Scope.ScopeKind CONTRACT

The scope for a CIVL-C contract. The contract scope contains the scope of the function signature and body.

Method Details

values

public static Scope.ScopeKind[] 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 Scope.ScopeKind 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