Interface Library

All Superinterfaces:

Namespace

public interface Library
extends Namespace

Interface for a Library dependency and namespace.

Nested Class Summary

Nested classes/interfaces inherited from interface Namespace

Namespace.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	UNKNOWN

Fields inherited from interface Namespace

DELIMITER, GLOBAL_NAMESPACE_ID, NAMESPACE_DELIMITER

Method Summary

Modifier and Type	Method	Description
String	getAssociatedProgramPath()
static Library	getContainingLibrary(Symbol symbol)	Get the Library which contains the specified external symbol.
default Namespace.Type	getType()	Returns the type of namespace, e.g., Library, Class, Namespace, Function.
void	setAssociatedProgramPath(String programPath)	Sets the program file pathname within the project which corresponds to this library.

Methods inherited from interface Namespace

getBody, getID, getName, getName, getParentNamespace, getPathList, getSymbol, isExternal, isGlobal, isLibrary, setParentNamespace

Field Details

UNKNOWN

static final String UNKNOWN

See Also:

• Constant Field Values

Method Details

getType

default Namespace.Type getType()

Description copied from interface: Namespace

Returns the type of namespace, e.g., Library, Class, Namespace, Function.

Specified by:

getType in interface Namespace

Returns:

the type of namespace, e.g., Library, Class, Namespace, Function

getAssociatedProgramPath

String getAssociatedProgramPath()

Returns:

the associated program file pathname within the project which corresponds to this library.

setAssociatedProgramPath

void setAssociatedProgramPath(String programPath)
                       throws InvalidInputException

Sets the program file pathname within the project which corresponds to this library.

NOTE: Assigning a path to UNKNOWN Library will be ignored.

Parameters:

programPath - a program file pathname or null to clear the stored path.

Throws:

InvalidInputException - on invalid programPath is specified

getContainingLibrary

static Library getContainingLibrary(Symbol symbol)

Get the Library which contains the specified external symbol.

Parameters:

symbol - external symbol

Returns:

null if symbol is null or not external