com.whitestein.lsps.lang.module

Class VariableInfo

java.lang.Object

com.whitestein.lsps.lang.module.VariableInfo

All Implemented Interfaces:

LangElement

public class VariableInfo
extends Object
implements LangElement

Information about variable; its name and access.

Author:

pna, vbu

Constructor Summary

Constructors

Constructor and Description
VariableInfo(NamespaceModel namespaceModel, String name, Type type) Creates a new public variable information.
VariableInfo(NamespaceModel namespaceModel, String name, Type type, boolean isPrivate, boolean isReadOnly) Creates a new variable information.
VariableInfo(NamespaceModel namespaceModel, String name, Type type, boolean isPrivate, boolean isReadOnly, Map<String,String> metadata) Creates a new variable information.

Method Summary

Modifier and Type	Method and Description
Object	getData() Returns the data.
Map<String,String>	getMetadata() Returns the metadata of this variable.
String	getMetadata(String key) Returns the metadata stored under a given key.
String	getName() Returns the variable name.
NamespaceModel	getNamespaceModel() Returns the namespace model that contains this variable.
Type	getType() Returns the type of variable.
boolean	hasMetadata(String key) Returns true if the metadata contain the given key.
boolean	isPrivate() Returns whether this variable is private.
boolean	isReadOnly() Returns whether this variable is read-only.
void	setData(Object data) Sets the data.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableInfo

public VariableInfo(NamespaceModel namespaceModel,
                    String name,
                    Type type)

Creates a new public variable information.

Parameters:

namespaceModel -

name -

type - type of variable

VariableInfo

public VariableInfo(NamespaceModel namespaceModel,
                    String name,
                    Type type,
                    boolean isPrivate,
                    boolean isReadOnly)

Creates a new variable information.

Parameters:

namespaceModel -

name -

type - type of variable

isPrivate - true if variable is private, false if it is public

isReadOnly - true if variable is read-only

VariableInfo

public VariableInfo(NamespaceModel namespaceModel,
                    String name,
                    Type type,
                    boolean isPrivate,
                    boolean isReadOnly,
                    Map<String,String> metadata)

Creates a new variable information.

Parameters:

namespaceModel -

name -

type - type of variable

isPrivate - true if variable is private, false if it is public

isReadOnly - true if variable is read-only

metadata -

Method Detail

getNamespaceModel

public NamespaceModel getNamespaceModel()

Returns the namespace model that contains this variable.

Returns:

the namespace model that contains this variable

getName

public String getName()

Returns the variable name.

Specified by:

getName in interface LangElement

Returns:

the variable name

getType

public Type getType()

Returns the type of variable.

Returns:

type of the variable

isPrivate

public boolean isPrivate()

Returns whether this variable is private.

Returns:

true if the variable is private, false if it is public

isReadOnly

public boolean isReadOnly()

Returns whether this variable is read-only.

Returns:

true if the variable is read-only, otherwise false

toString

public String toString()

Overrides:

toString in class Object

getMetadata

public Map<String,String> getMetadata()

Returns the metadata of this variable.

Specified by:

getMetadata in interface LangElement

Returns:

the metadata of this variable

getMetadata

public String getMetadata(String key)

Returns the metadata stored under a given key.

Specified by:

getMetadata in interface LangElement

Parameters:

key -

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

setData

public void setData(Object data)

Sets the data.

Parameters:

data -

getData

public Object getData()

Returns the data.

Specified by:

getData in interface LangElement

Returns:

the data