com.whitestein.lsps.lang.module

Class ConstantInfo

java.lang.Object

com.whitestein.lsps.lang.module.ConstantInfo

All Implemented Interfaces:

LangElement, Cloneable

public class ConstantInfo
extends Object
implements LangElement, Cloneable

Author:

mvo

Constructor Summary

Constructors

Constructor and Description
ConstantInfo(String name, Type type, boolean isPrivate)
ConstantInfo(String name, Type type, boolean isPrivate, boolean isLiteral, Object literalValue)
ConstantInfo(String name, Type type, boolean isPrivate, boolean isLiteral, Object literalValue, Map<String,String> metadata)

Method Summary

Modifier and Type	Method and Description
ConstantInfo	clone()
Object	getData() Returns the associated element data.
Object	getLiteralValue() If the constant is literal, returns the literal value.
Map<String,String>	getMetadata() Returns the metadata of this type
String	getMetadata(String key) Returns the metadata stored under a given key.
Module	getModule()
String	getName() Returns the element name.
Type	getType()
boolean	hasMetadata(String key) Returns true if the metadata contain the given key.
boolean	isLiteral() Returns true if the constant definition is a literal.
boolean	isPrivate()
void	setData(Object data)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConstantInfo

public ConstantInfo(String name,
                    Type type,
                    boolean isPrivate)

Parameters:

name -

type -

isPrivate -

ConstantInfo

public ConstantInfo(String name,
                    Type type,
                    boolean isPrivate,
                    boolean isLiteral,
                    Object literalValue)

Parameters:

name -

type -

isPrivate -

isLiteral - true if the constant definition is a literal

literalValue - the literal value

ConstantInfo

public ConstantInfo(String name,
                    Type type,
                    boolean isPrivate,
                    boolean isLiteral,
                    Object literalValue,
                    Map<String,String> metadata)

Parameters:

name -

type -

isPrivate -

isLiteral - true if the constant definition is a literal

literalValue - the literal value

metadata -

Method Detail

getModule

public Module getModule()

Returns:

the module where this constant is declared

getName

public String getName()

Description copied from interface: LangElement

Returns the element name.

Specified by:

getName in interface LangElement

Returns:

the constant name

getType

public Type getType()

Returns:

the constant type

isPrivate

public boolean isPrivate()

Returns:

the constant private flag

isLiteral

public boolean isLiteral()

Returns true if the constant definition is a literal.

Returns:

true if the constant definition is a literal

getLiteralValue

public Object getLiteralValue()

If the constant is literal, returns the literal value.

Returns:

the literal value

getMetadata

public Map<String,String> getMetadata()

Description copied from interface: LangElement

Returns the metadata of this type

Specified by:

getMetadata in interface LangElement

Returns:

the metadata of this type

getMetadata

public String getMetadata(String key)

Description copied from interface: LangElement

Returns the metadata stored under a given key.

Specified by:

getMetadata in interface LangElement

Returns:

the metadata stored under a given key

hasMetadata

public boolean hasMetadata(String key)

Description copied from interface: LangElement

Returns true if the metadata contain the given key.

Specified by:

hasMetadata in interface LangElement

Returns:

true if the metadata contain the given key

getData

public Object getData()

Description copied from interface: LangElement

Returns the associated element data.

Specified by:

getData in interface LangElement

Returns:

the data

setData

public void setData(Object data)

Parameters:

data -

clone

public ConstantInfo clone()

Overrides:

clone in class Object