com.whitestein.lsps.lang.module

Class BasicModule

java.lang.Object

com.whitestein.lsps.lang.module.AbstractNamespace

com.whitestein.lsps.lang.module.BasicModule

All Implemented Interfaces:

Module, NamespaceModel

public class BasicModule
extends AbstractNamespace
implements Module

default implementation of Module

Author:

pna

Constructor Summary

Constructors

Constructor and Description
BasicModule(String name) Creates new instance.
BasicModule(String name, Collection<? extends Module> imports) Creates new instance.

Method Summary

Modifier and Type	Method and Description
void	addConstant(ConstantInfo constantInfo) Adds a constant.
void	addReferencedOperation(ReferencedOperation operation) Adds referenced operation so that it can be referenced for expressions compiled to java.
void	addSignature(FunctionSignature signature) Registers a function signature in this namespace.
Map<String,Module>	allImportedModules() Returns an immutable map of all imports.
BasicModule	copyStatic() Creates a new basic module with same types, functions, constants, but variables are not copied.
NamedClassType	getClassType(String name) Returns a class type defined in this module with a given name.
Collection<NamedClassType>	getClassTypes() Returns class types, declared in this Module
ConstantInfo	getConstant(String name) Returns a constant declared in this module.
Collection<ConstantInfo>	getConstants() Returns a collection of constants declared in this module.
Object	getConstantValue(String name) Returns the constant value.
Collection<EnumerationType>	getEnumerationTypes() Returns a collection of enumeration types declared in this module.
Collection<InterfaceType>	getInterfaceTypes() Returns interface types, declared in this Module
Collection<FunctionSignature>	getLocalSignaturesForName(String name) Returns the local function signatures for given name.
Module	getModule() Returns the enclosing module.
Collection<NamedType>	getNamedTypes() Returns a collection of named types (records, enumerations etc.) declared in this module.
NamespaceModel	getParent() Returns the parent namespace or null.
Collection<RecordType>	getRecordTypes() Returns record types, declared in this Module
ReferencedOperation	getReferencedOperation(String id) Returns operation for the id.
Collection<FunctionSignature>	getSignatures() Returns function signatures defined in this namespace.
ClassType	getStaticType() Returns type for this namespace used for static methods.
ClassType	getThisType() Returns type for this namespace.
NamedType	getTypeForName(String typeName) Returns registered named type corresponding to given name.
protected Map<String,Module>	importedModules() Returns an immutable map of imports.
boolean	isModule() Returns true if this is a module.
void	registerEnumeration(EnumerationType type) Registers an enumeration type.
void	registerInterfaceType(InterfaceType type) Registers given interface type, that is declared in this Module
void	registerRecordType(RecordType type) Registers given record type, that is declared in this Module
void	setConstantValue(String name, Object value) Sets the constant value.

Methods inherited from class com.whitestein.lsps.lang.module.AbstractNamespace

addModules, addVariable, addVariable, addVariable, addVariable, findNamedType, getAllImportedModules, getAlternativeName, getCompiled, getConstants, getExtensionMethods, getExtensionMethods, getImportedModuleByName, getImportedModules, getName, getSignatures, getSignaturesForName, getSignaturesForName, getSignaturesForNamedArgs, getVariable, getVariable, getVariablePrivacy, getVariables, getVariables, getVisibleConstants, getVisibleNamedTypes, getVisibleRecordTypes, getVisibleSignatures, getVisibleVariables, setAlternativeName, setCompiled, toString, validateIdentifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.whitestein.lsps.lang.module.NamespaceModel

addVariable, addVariable, addVariable, addVariable, findNamedType, getAllImportedModules, getAlternativeName, getCompiled, getConstants, getExtensionMethods, getExtensionMethods, getImportedModuleByName, getImportedModules, getName, getSignatures, getSignaturesForName, getSignaturesForName, getSignaturesForNamedArgs, getVariable, getVariable, getVariablePrivacy, getVariables, getVariables, getVisibleConstants, getVisibleNamedTypes, getVisibleRecordTypes, getVisibleSignatures, getVisibleVariables, setAlternativeName, setCompiled, validateIdentifier

Constructor Detail

BasicModule

public BasicModule(String name)

Creates new instance.

Parameters:

name - the name

BasicModule

public BasicModule(String name,
                   Collection<? extends Module> imports)

Creates new instance.

Parameters:

name - the name

imports - the imports

Method Detail

importedModules

protected Map<String,Module> importedModules()

Description copied from class: AbstractNamespace

Returns an immutable map of imports.

Specified by:

importedModules in class AbstractNamespace

Returns:

an immutable map of imports

allImportedModules

public Map<String,Module> allImportedModules()

Description copied from class: AbstractNamespace

Returns an immutable map of all imports.

Specified by:

allImportedModules in class AbstractNamespace

Returns:

an immutable map of all imports

getTypeForName

public NamedType getTypeForName(String typeName)

Description copied from interface: NamespaceModel

Returns registered named type corresponding to given name.

Specified by:

getTypeForName in interface NamespaceModel

Returns:

registered type with given name

getClassType

public NamedClassType getClassType(String name)

Description copied from interface: Module

Returns a class type defined in this module with a given name.

Specified by:

getClassType in interface Module

Returns:

a record type

getClassTypes

public Collection<NamedClassType> getClassTypes()

Description copied from interface: Module

Returns class types, declared in this Module

Specified by:

getClassTypes in interface Module

Returns:

class types, declared in this Module

getRecordTypes

public Collection<RecordType> getRecordTypes()

Description copied from interface: Module

Returns record types, declared in this Module

Specified by:

getRecordTypes in interface Module

Returns:

record types, declared in this Module

registerRecordType

public void registerRecordType(RecordType type)

Description copied from interface: Module

Registers given record type, that is declared in this Module

Specified by:

registerRecordType in interface Module

registerInterfaceType

public void registerInterfaceType(InterfaceType type)

Description copied from interface: Module

Registers given interface type, that is declared in this Module

Specified by:

registerInterfaceType in interface Module

getInterfaceTypes

public Collection<InterfaceType> getInterfaceTypes()

Description copied from interface: Module

Returns interface types, declared in this Module

Specified by:

getInterfaceTypes in interface Module

Returns:

interface types, declared in this Module

registerEnumeration

public void registerEnumeration(EnumerationType type)

Description copied from interface: Module

Registers an enumeration type.

Specified by:

registerEnumeration in interface Module

getEnumerationTypes

public Collection<EnumerationType> getEnumerationTypes()

Description copied from interface: Module

Returns a collection of enumeration types declared in this module.

Specified by:

getEnumerationTypes in interface Module

Returns:

a collection of enumeration types declared in this module

getNamedTypes

public Collection<NamedType> getNamedTypes()

Description copied from interface: Module

Returns a collection of named types (records, enumerations etc.) declared in this module.

Specified by:

getNamedTypes in interface Module

Returns:

a collection of named types

getParent

public NamespaceModel getParent()

Description copied from interface: NamespaceModel

Returns the parent namespace or null.

Specified by:

getParent in interface NamespaceModel

Returns:

the parent namespace or null

addSignature

public void addSignature(FunctionSignature signature)

Description copied from interface: NamespaceModel

Registers a function signature in this namespace.

Specified by:

addSignature in interface NamespaceModel

Parameters:

signature - function signature to be registered in this namespace

getSignatures

public final Collection<FunctionSignature> getSignatures()

Description copied from interface: NamespaceModel

Returns function signatures defined in this namespace.

Specified by:

getSignatures in interface NamespaceModel

Returns:

collection of function signatures

getLocalSignaturesForName

public Collection<FunctionSignature> getLocalSignaturesForName(String name)

Description copied from interface: NamespaceModel

Returns the local function signatures for given name.

Specified by:

getLocalSignaturesForName in interface NamespaceModel

Returns:

the local function signatures for given name

getModule

public Module getModule()

Description copied from interface: NamespaceModel

Returns the enclosing module.

Specified by:

getModule in interface NamespaceModel

Returns:

the enclosing module

isModule

public boolean isModule()

Description copied from interface: NamespaceModel

Returns true if this is a module.

Specified by:

isModule in interface NamespaceModel

Returns:

true if this is a module

addConstant

public void addConstant(ConstantInfo constantInfo)

Description copied from interface: Module

Adds a constant.

Specified by:

addConstant in interface Module

getConstant

public ConstantInfo getConstant(String name)

Description copied from interface: Module

Returns a constant declared in this module.

Specified by:

getConstant in interface Module

Returns:

the constant info or null if there is no constant with a given name

getConstantValue

public Object getConstantValue(String name)

Description copied from interface: Module

Returns the constant value.

Specified by:

getConstantValue in interface Module

Returns:

the constant value

setConstantValue

public void setConstantValue(String name,
                             Object value)

Description copied from interface: Module

Sets the constant value.

Specified by:

setConstantValue in interface Module

getConstants

public Collection<ConstantInfo> getConstants()

Description copied from interface: Module

Returns a collection of constants declared in this module.

Specified by:

getConstants in interface Module

Returns:

a collection of constants declared in this module

addReferencedOperation

public void addReferencedOperation(ReferencedOperation operation)

Description copied from interface: NamespaceModel

Adds referenced operation so that it can be referenced for expressions compiled to java.

Specified by:

addReferencedOperation in interface NamespaceModel

getReferencedOperation

public ReferencedOperation getReferencedOperation(String id)

Description copied from interface: NamespaceModel

Returns operation for the id.

Specified by:

getReferencedOperation in interface NamespaceModel

Returns:

operation

copyStatic

public BasicModule copyStatic()

Creates a new basic module with same types, functions, constants, but variables are not copied.

Returns:

a new basic module with data types, functions, constants

getThisType

public ClassType getThisType()

Description copied from interface: NamespaceModel

Returns type for this namespace.

Specified by:

getThisType in interface NamespaceModel

Returns:

type for this namespace

getStaticType

public ClassType getStaticType()

Description copied from interface: NamespaceModel

Returns type for this namespace used for static methods.

Specified by:

getStaticType in interface NamespaceModel

Returns:

type for this namespace