Interface CodePathElements

All Superinterfaces:

CodeItem, CodeMutable, CodeMutableItem, CodeNode, CodeNodeContainer<CodePathElement>, CodeNodeItem, CodeNodeItemContainer<CodePathElement>, CodeNodeItemContainerFlat<CodePathElement>, CodeNodeItemCopyable<CodePackage, CodePathElements>, CodeWithContext, Iterable<CodePathElement>

public interface CodePathElements
extends CodeNodeItemContainerFlat<CodePathElement>, CodeNodeItemCopyable<CodePackage, CodePathElements>

CodeNodeItemContainerFlat containing the CodePathElements of a CodePackage.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
void	add(CodePathElement child)	Attention: This method is only for advanced usage.
boolean	containsPackage(CodePackage child)
boolean	containsSubPackage(CodePackage child)
CodePathElements	copy()
CodePathElements	copy(CodeCopyMapper mapper)
CodeFile	createFile(String simpleName)	Attention: This method is just a factory operation.
CodePackage	createPackage(String simpleName)	Attention: This method is just a factory operation.
CodeType	createType(String simpleName)	Attention: This method is just a factory operation.
CodePathElement	get(String simpleName)
List<? extends CodePathElement>	getDeclared()	Attention: This method can trigger expensive classpath scanning (or filesystem traversal) on its first call.
CodeFile	getFile(CodeName path)
CodeFile	getFile(String simpleName)
CodeFile	getOrCreateFile(CodeName path, boolean add)
default CodeFile	getOrCreateFile(String path)
CodePackage	getOrCreatePackage(CodeName path, boolean add)
default CodePackage	getOrCreatePackage(String path)
CodePackage	getPackage(CodeName path)
CodePackage	getPackage(String simpleName)
CodePackage	getParent()
CodeType	getType(String simpleName)

Methods inherited from interface CodeItem

getLanguage, getSourceCode, write, write, write, write, write, write

Methods inherited from interface CodeMutable

isImmutable, isMutable

Methods inherited from interface CodeMutableItem

getReflectiveObject, setImmutable

Methods inherited from interface CodeNodeContainer

isEmpty, iterator

Methods inherited from interface CodeNodeItemContainer

remove

Methods inherited from interface CodeWithContext

getContext, getSource

Methods inherited from interface Iterable

forEach, spliterator

Method Details

getParent

CodePackage getParent()

Specified by:

getParent in interface CodeNode

Specified by:

getParent in interface CodeNodeItemContainer<CodePathElement>

Specified by:

getParent in interface CodeNodeItemCopyable<CodePackage, CodePathElements>

Returns:

the parent of this CodeNode. May only be null for instances of CodeContext.

getDeclared

List<? extends CodePathElement> getDeclared()

Attention:
This method can trigger expensive classpath scanning (or filesystem traversal) on its first call.

Specified by:

getDeclared in interface CodeNodeContainer<CodePathElement>

Returns:

all items directly contained in this container.

get

CodePathElement get(String simpleName)

Parameters:

simpleName - the simple name of the requested CodePathElement.

Returns:

the CodePathElement from all items with the given name or null if not found.

getFile

CodeFile getFile(String simpleName)

Parameters:

simpleName - the simple name of the requested CodeFile.

Returns:

the CodeFile with the given name or null if not found.

getFile

CodeFile getFile(CodeName path)

Parameters:

path - the CodeName to traverse.

Returns:

the traversed CodeFile or null if not found.

createFile

CodeFile createFile(String simpleName)

Attention: This method is just a factory operation. It will not add the created CodeFile. Use getOrCreateFile(String) instead to also add.

Parameters:

simpleName - the simple name of the new CodeFile.

Returns:

a new CodeFile containing an empty top-level CodeType of the same name.

getOrCreateFile

default CodeFile getOrCreateFile(String path)

Parameters:

path - the simple name or a relative path to the requested CodeFile.

Returns:

the existing or newly created and added CodeFile.

See Also:

• getOrCreateFile(CodeName, boolean)

getOrCreateFile

CodeFile getOrCreateFile(CodeName path,
 boolean add)

Parameters:

path - the CodeName leading to the requested child relative to the package of this children. Will typically be invoked on the children of a root package with a qualified name parsed via CodeProvider.parseName(String).

add - - true to add a newly created CodeFile, false otherwise.

Returns:

the existing or newly created CodeFile.

getPackage

CodePackage getPackage(String simpleName)

Parameters:

simpleName - the simple name of the requested CodePackage.

Returns:

the CodePackage with the given name or null if not found.

getPackage

CodePackage getPackage(CodeName path)

Parameters:

path - the CodeName leading to the requested child relative to the package of this children. Will typically be invoked on the children of a root package with a qualified name parsed via CodeProvider.parseName(String).

Returns:

the traversed CodePackage or null if not found.

getOrCreatePackage

CodePackage getOrCreatePackage(CodeName path,
 boolean add)

Parameters:

path - the CodeName leading to the requested child relative to the package of this children. Will typically be invoked on the children of a root package with a qualified name parsed via CodeProvider.parseName(String).

add - - true to add newly created packages, false otherwise.

Returns:

the traversed CodePackage. Has been created if it did not already exist.

getOrCreatePackage

default CodePackage getOrCreatePackage(String path)

Parameters:

path - the simple name or a relative path to the requested CodePackage.

Returns:

the traversed CodePackage. Has been created and added if it did not already exist.

createPackage

CodePackage createPackage(String simpleName)

Attention: This method is just a factory operation. It will not add the created CodePackage. Use getOrCreatePackage(String) instead to also add.

Parameters:

simpleName - the simple name of the new CodePackage.

Returns:

a new empty CodePackage.

getType

CodeType getType(String simpleName)

Parameters:

simpleName - the simple name of the requested CodeType.

Returns:

the CodeType with the given name or null if not found.

createType

CodeType createType(String simpleName)

Attention: This method is just a factory operation. It will not add the CodeFile of the created CodeType. Use getOrCreateFile(String) instead to also add and then call CodeFile.getType().

Parameters:

simpleName - the simple name of the requested CodeType.

Returns:

the top-level CodeType that has been created together with its CodeFile.

See Also:

• createFile(String)

add

void add(CodePathElement child)

Attention: This method is only for advanced usage. Whenever suitable prefer to use methods such as getOrCreatePackage(CodeName, boolean) or getOrCreateFile(CodeName, boolean) instead.

Parameters:

child - the CodePathElement to add as child.

containsPackage

boolean containsPackage(CodePackage child)

Parameters:

child - the potential sub-package.

Returns:

true if the given CodePackage is equal to the owning package or is a direct or indirect sub-package of this CodePackage, false otherwise.

containsSubPackage

boolean containsSubPackage(CodePackage child)

Parameters:

child - the potential sub-package.

Returns:

true if the given CodePackage is a direct or indirect sub-package of this CodePackage, false otherwise.

copy

CodePathElements copy()

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemContainer<CodePathElement>

Specified by:

copy in interface CodeNodeItemContainerFlat<CodePathElement>

Specified by:

copy in interface CodeNodeItemCopyable<CodePackage, CodePathElements>

Returns:

a new mutable copy of this CodeMutableItem. Will be a deep-copy with copies of all child CodeMutableItems.

copy

CodePathElements copy(CodeCopyMapper mapper)

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemContainer<CodePathElement>

Specified by:

copy in interface CodeNodeItemCopyable<CodePackage, CodePathElements>

Parameters:

mapper - the CodeCopyMapper used to map involved nodes during copy.

Returns:

a CodeMutableItem.copy() with the related objects mapped using the given CodeCopyMapper.