com.whitestein.lsps.lang.module

Class AbstractNamespace

java.lang.Object

com.whitestein.lsps.lang.module.AbstractNamespace

All Implemented Interfaces:

NamespaceModel

Direct Known Subclasses:

BasicModule, BasicModulePart, ClassNamespaceModel

public abstract class AbstractNamespace
extends Object
implements NamespaceModel

This class is a common ancestor for Module and ModulePart.

Author:

pna, vbu

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNamespace(String name) Creates a new namespace with given name.

Method Summary

Modifier and Type	Method and Description
protected void	addModules(Collection<? extends Module> modules, Map<String,Module> map, boolean transitive) Adds modules to a map.
void	addVariable(String variableName, Type variableType) Registers a public variable in this namespace.
void	addVariable(String variableName, Type variableType, boolean isPrivate) Registers a variable in this namespace.
void	addVariable(String variableName, Type variableType, boolean isPrivate, boolean isReadOnly) Registers a variable in this namespace.
void	addVariable(VariableInfo variable) Registers the given variable in this namespace.
abstract Map<String,Module>	allImportedModules() Returns an immutable map of all imports.
NamedType	findNamedType(QID qid) Find a named type.
Collection<Module>	getAllImportedModules() Returns this module and all imported modules along with their imported modules recursively.
String	getAlternativeName() Returns alternative name.
Constructor<?>	getCompiled() Returns constructor of class that was generated by compilation to java for this namespace model.
Collection<ConstantInfo>	getConstants(QID name) Returns a list of constants for the given fully qualified name.
Collection<SignatureMapping>	getExtensionMethods(Type type) Returns a collection of extension methods for a given type.
Collection<SignatureMapping>	getExtensionMethods(Type type, String methodName) Returns a collection of extension methods for a given type and name.
Module	getImportedModuleByName(String moduleName) Returns a reachable imported module by its module name or null if no such module exists.
Collection<Module>	getImportedModules() Returns imported modules.
String	getName() Returns the name of defined type, which is unique in the module.
Collection<SignatureMapping>	getSignatures(String namePattern, List<? extends Type> args, Type returnType, Map<String,String> metadataPattern) Returns a collection of function signatures for the given parameters.
Collection<SignatureMapping>	getSignaturesForName(QID name) Returns a collection of function signatures for the given name.
Collection<SignatureMapping>	getSignaturesForName(QID name, ClosureType type) Returns a collection of function signatures for the given name, argument count and expected signature closure type.
Collection<SignatureMapping>	getSignaturesForNamedArgs(QID name, Map<String,Type> args, Type returnType) Returns a collection of function signatures for the given name, arguments names and types and a return type.
VariableInfo	getVariable(String variableName) Returns a local variable for the given name.
VariableInfo	getVariable(String variableName, boolean includePrivate) Returns a local variable info for the given name.
boolean	getVariablePrivacy(String variableName) Returns a local variable privacy for the given name.
Collection<VariableInfo>	getVariables() Returns a collection of all variables in this namespace.
Collection<VariableInfo>	getVariables(QID name) Returns a list of variables for the given fully qualified name.
Collection<ConstantInfo>	getVisibleConstants() Returns a collection of all visible constants.
Collection<NamedType>	getVisibleNamedTypes() Returns a collection of all visible named types (records, enumerations etc.).
Collection<RecordType>	getVisibleRecordTypes() Returns a collection of all visible defined record types.
Collection<FunctionSignature>	getVisibleSignatures() Returns a collection of all visible function signatures.
Collection<VariableInfo>	getVisibleVariables() Returns a collection of all visible variables.
protected abstract Map<String,Module>	importedModules() Returns an immutable map of imports.
void	setAlternativeName(String alternativeName) Sets alternative name.
void	setCompiled(Constructor<?> constructor) Sets constructor of class that was generated by compilation to java for this namespace model.
String	toString()
boolean	validateIdentifier(String identifierName) Returns true if name is valid identifier according the used language.

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

addReferencedOperation, addSignature, getLocalSignaturesForName, getModule, getParent, getReferencedOperation, getSignatures, getStaticType, getThisType, getTypeForName, isModule

Constructor Detail

AbstractNamespace

protected AbstractNamespace(String name)

Creates a new namespace with given name.

Parameters:

name - string containing name for the new namespace

Method Detail

addVariable

public void addVariable(String variableName,
                        Type variableType)

Description copied from interface: NamespaceModel

Registers a public variable in this namespace.

Specified by:

addVariable in interface NamespaceModel

Parameters:

variableName - string containing the name of the variable

variableType - type of the variable

addVariable

public void addVariable(String variableName,
                        Type variableType,
                        boolean isPrivate)

Description copied from interface: NamespaceModel

Registers a variable in this namespace.

Specified by:

addVariable in interface NamespaceModel

Parameters:

variableName - string containing the name of the variable

variableType - type of the variable

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

addVariable

public void addVariable(String variableName,
                        Type variableType,
                        boolean isPrivate,
                        boolean isReadOnly)

Description copied from interface: NamespaceModel

Registers a variable in this namespace.

Specified by:

addVariable in interface NamespaceModel

Parameters:

variableName - string containing the name of the variable

variableType - type of the variable

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

isReadOnly - true if the variable is read-only, false otherwise

addVariable

public void addVariable(VariableInfo variable)

Description copied from interface: NamespaceModel

Registers the given variable in this namespace.

Specified by:

addVariable in interface NamespaceModel

validateIdentifier

public boolean validateIdentifier(String identifierName)

Returns true if name is valid identifier according the used language.

Specified by:

validateIdentifier in interface NamespaceModel

Parameters:

identifierName - string containing the proposed identifier

Returns:

true if name is valid identifier according the used language.

getVariable

public VariableInfo getVariable(String variableName)

Description copied from interface: NamespaceModel

Returns a local variable for the given name.

Specified by:

getVariable in interface NamespaceModel

Returns:

a local variable or null

getVariablePrivacy

public boolean getVariablePrivacy(String variableName)

Description copied from interface: NamespaceModel

Returns a local variable privacy for the given name. This method is used to determine whether "this.NAME" is private.

Specified by:

getVariablePrivacy in interface NamespaceModel

Returns:

true if variable is private

getVariable

public final VariableInfo getVariable(String variableName,
                                      boolean includePrivate)

Description copied from interface: NamespaceModel

Returns a local variable info for the given name. This method is used to determine what "this.NAME" means.

Specified by:

getVariable in interface NamespaceModel

includePrivate - true if also private variable can be returned, false if only public

Returns:

a local variable with given name

getVariables

public Collection<VariableInfo> getVariables(QID name)

Description copied from interface: NamespaceModel

Returns a list of variables for the given fully qualified name.

Specified by:

getVariables in interface NamespaceModel

Returns:

a list of variables for the fully qualified name

getConstants

public Collection<ConstantInfo> getConstants(QID name)

Description copied from interface: NamespaceModel

Returns a list of constants for the given fully qualified name.

Specified by:

getConstants in interface NamespaceModel

Returns:

a list of constants for the fully qualified name

getVariables

public Collection<VariableInfo> getVariables()

Description copied from interface: NamespaceModel

Returns a collection of all variables in this namespace.

Specified by:

getVariables in interface NamespaceModel

Returns:

a collection of all variables in this namespace

getSignaturesForName

public Collection<SignatureMapping> getSignaturesForName(QID name)

Description copied from interface: NamespaceModel

Returns a collection of function signatures for the given name.

Specified by:

getSignaturesForName in interface NamespaceModel

Returns:

a collection of signature mappings

getSignaturesForName

public Collection<SignatureMapping> getSignaturesForName(QID name,
                                                         ClosureType type)

Description copied from interface: NamespaceModel

Returns a collection of function signatures for the given name, argument count and expected signature closure type.

Specified by:

getSignaturesForName in interface NamespaceModel

Returns:

a collection of signature mappings

getSignaturesForNamedArgs

public Collection<SignatureMapping> getSignaturesForNamedArgs(QID name,
                                                              Map<String,Type> args,
                                                              Type returnType)

Description copied from interface: NamespaceModel

Returns a collection of function signatures for the given name, arguments names and types and a return type.

Specified by:

getSignaturesForNamedArgs in interface NamespaceModel

Returns:

a collection of signature mappings

getSignatures

public Collection<SignatureMapping> getSignatures(String namePattern,
                                                  List<? extends Type> args,
                                                  Type returnType,
                                                  Map<String,String> metadataPattern)

Description copied from interface: NamespaceModel

Returns a collection of function signatures for the given parameters.

Specified by:

getSignatures in interface NamespaceModel

Parameters:

namePattern - regular expression

metadataPattern - map with required metadata, values are regular expressions.

Returns:

a collection of signature mappings

getExtensionMethods

public Collection<SignatureMapping> getExtensionMethods(Type type,
                                                        String methodName)

Description copied from interface: NamespaceModel

Returns a collection of extension methods for a given type and name.

Specified by:

getExtensionMethods in interface NamespaceModel

Returns:

a collection of signature mappings

getExtensionMethods

public Collection<SignatureMapping> getExtensionMethods(Type type)

Description copied from interface: NamespaceModel

Returns a collection of extension methods for a given type.

Specified by:

getExtensionMethods in interface NamespaceModel

Returns:

a collection of signature mappings

importedModules

protected abstract Map<String,Module> importedModules()

Returns an immutable map of imports.

Returns:

an immutable map of imports

allImportedModules

public abstract Map<String,Module> allImportedModules()

Returns an immutable map of all imports.

Returns:

an immutable map of all imports

addModules

protected void addModules(Collection<? extends Module> modules,
                          Map<String,Module> map,
                          boolean transitive)

Adds modules to a map.

Parameters:

modules -

map -

transitive -

getImportedModules

public Collection<Module> getImportedModules()

Description copied from interface: NamespaceModel

Returns imported modules.

Specified by:

getImportedModules in interface NamespaceModel

Returns:

collection of imported modules

getAllImportedModules

public Collection<Module> getAllImportedModules()

Description copied from interface: NamespaceModel

Returns this module and all imported modules along with their imported modules recursively. Each module is present only once in the result.

Specified by:

getAllImportedModules in interface NamespaceModel

Returns:

all imported modules

getImportedModuleByName

public Module getImportedModuleByName(String moduleName)

Description copied from interface: NamespaceModel

Returns a reachable imported module by its module name or null if no such module exists. Includes also this module.

Specified by:

getImportedModuleByName in interface NamespaceModel

Returns:

the imported module by its module name

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Description copied from interface: NamespaceModel

Returns the name of defined type, which is unique in the module.

Specified by:

getName in interface NamespaceModel

Returns:

string containing name of this type

getVisibleRecordTypes

public Collection<RecordType> getVisibleRecordTypes()

Description copied from interface: NamespaceModel

Returns a collection of all visible defined record types.

Specified by:

getVisibleRecordTypes in interface NamespaceModel

Returns:

a collection of all visible defined record types

getVisibleNamedTypes

public Collection<NamedType> getVisibleNamedTypes()

Description copied from interface: NamespaceModel

Returns a collection of all visible named types (records, enumerations etc.).

Specified by:

getVisibleNamedTypes in interface NamespaceModel

Returns:

a collection of all visible named types

getVisibleSignatures

public Collection<FunctionSignature> getVisibleSignatures()

Description copied from interface: NamespaceModel

Returns a collection of all visible function signatures.

Specified by:

getVisibleSignatures in interface NamespaceModel

Returns:

a collection of all visible function signatures

getVisibleVariables

public Collection<VariableInfo> getVisibleVariables()

Description copied from interface: NamespaceModel

Returns a collection of all visible variables. Both variable visibility and shadowing is taken into account.

Specified by:

getVisibleVariables in interface NamespaceModel

Returns:

a collection of all visible variables

getAlternativeName

public String getAlternativeName()

Description copied from interface: NamespaceModel

Returns alternative name. If the model is imported and alternative name is not null the namespace model is registered in imports also under this name.

Specified by:

getAlternativeName in interface NamespaceModel

Returns:

alternative name

setAlternativeName

public void setAlternativeName(String alternativeName)

Description copied from interface: NamespaceModel

Sets alternative name. If the model is imported and alternative name is not null the namespace model is registered in imports also under this name.

Specified by:

setAlternativeName in interface NamespaceModel

getVisibleConstants

public Collection<ConstantInfo> getVisibleConstants()

Description copied from interface: NamespaceModel

Returns a collection of all visible constants.

Specified by:

getVisibleConstants in interface NamespaceModel

Returns:

a collection of all visible constants

findNamedType

public NamedType findNamedType(QID qid)
                        throws AmbiguousTypeException

Description copied from interface: NamespaceModel

Find a named type.

Specified by:

findNamedType in interface NamespaceModel

Parameters:

qid - the type name, not null.

Returns:

a record or enum type or null if not found

Throws:

AmbiguousTypeException

getCompiled

public Constructor<?> getCompiled()

Description copied from interface: NamespaceModel

Returns constructor of class that was generated by compilation to java for this namespace model. Constructor has one parameter of type Namespace

Specified by:

getCompiled in interface NamespaceModel

Returns:

constructor of class that was generated by compilation to java for this namespace model

setCompiled

public void setCompiled(Constructor<?> constructor)

Description copied from interface: NamespaceModel

Sets constructor of class that was generated by compilation to java for this namespace model. Constructor has one parameter of type Namespace

Specified by:

setCompiled in interface NamespaceModel