Package org.ek9lang.compiler.symbols

Enum Class ISymbol.SymbolCategory

java.lang.Object

java.lang.Enum<ISymbol.SymbolCategory>

org.ek9lang.compiler.symbols.ISymbol.SymbolCategory

All Implemented Interfaces:

Serializable, Comparable<ISymbol.SymbolCategory>, Constable

Enclosing interface:

ISymbol

public static enum ISymbol.SymbolCategory
extends Enum<ISymbol.SymbolCategory>

Typically used on symbols; so we know their broad use and type. A Function is both a type and a method because we want to use it as a types variable but also call it. So we may need to alter these methods below to treat a function also as a type and a method. A control is an example of a switch statement that can return a value - we may add others.

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
CONTROL
FUNCTION
METHOD
TEMPLATE_FUNCTION
TEMPLATE_TYPE
TYPE
VARIABLE

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TYPE

public static final ISymbol.SymbolCategory TYPE

TEMPLATE_TYPE

public static final ISymbol.SymbolCategory TEMPLATE_TYPE

METHOD

public static final ISymbol.SymbolCategory METHOD

TEMPLATE_FUNCTION

public static final ISymbol.SymbolCategory TEMPLATE_FUNCTION

FUNCTION

public static final ISymbol.SymbolCategory FUNCTION

CONTROL

public static final ISymbol.SymbolCategory CONTROL

VARIABLE

public static final ISymbol.SymbolCategory VARIABLE

Method Details

values

public static ISymbol.SymbolCategory[] 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 ISymbol.SymbolCategory 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

getDescription

public String getDescription()