Class BasePackage

java.lang.Object

io.github.mmm.code.base.item.BaseItem

io.github.mmm.code.base.item.BaseMutableItem

io.github.mmm.code.base.node.BaseNodeItem

io.github.mmm.code.base.element.BaseElement

io.github.mmm.code.base.element.BaseElementWithQualifiedName

io.github.mmm.code.base.BasePathElement

io.github.mmm.code.base.BasePackage

All Implemented Interfaces:

io.github.mmm.code.api.CodePackage, io.github.mmm.code.api.CodePathElement, io.github.mmm.code.api.CodeWithContext, io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.node.CodeNode, io.github.mmm.code.api.CodePackage>, io.github.mmm.code.api.element.CodeElement, io.github.mmm.code.api.item.CodeItem, io.github.mmm.code.api.item.CodeItemWithComment, io.github.mmm.code.api.item.CodeItemWithQualifiedName, io.github.mmm.code.api.item.CodeItemWithQualifiedNameAndParentPackage, io.github.mmm.code.api.item.CodeMutableItem, io.github.mmm.code.api.item.CodeMutableItemWithComment, io.github.mmm.code.api.item.CodeMutableItemWithQualifiedName, io.github.mmm.code.api.node.CodeContainer, io.github.mmm.code.api.node.CodeNode, io.github.mmm.code.api.node.CodeNodeItem, io.github.mmm.code.api.node.CodeNodeWithFileWriting, io.github.mmm.code.api.object.CodeMutable

public final class BasePackage
extends BasePathElement
implements io.github.mmm.code.api.CodePackage

Base implementation of CodePackage.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME_DEFAULT	Simple name of the default (root) package.
static final String	NAME_JAVA	Simple name "java".
static final String	NAME_LANG	Simple name "lang".
static final String	NAME_UTIL	Simple name "util".

Fields inherited from interface io.github.mmm.code.api.item.CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Constructor Summary

Constructors

Constructor	Description
BasePackage(BasePackage template, io.github.mmm.code.api.copy.CodeCopyMapper mapper)	The copy-constructor.
BasePackage(BasePackage parentPackage, String simpleName)	The constructor.
BasePackage(BasePackage parentPackage, String simpleName, Package reflectiveObject, Supplier<BasePackage> sourceSupplier, boolean systemImmutable)	The constructor.
BasePackage(BaseSource source)	The constructor for a root package.

Method Summary

Modifier and Type	Method	Description
BasePackage	copy()
BasePackage	copy(io.github.mmm.code.api.copy.CodeCopyMapper mapper)
protected void	doSetImmutable()	Called on the first call of BaseMutableItem.setImmutable().
protected void	doWrite(Appendable sink, String newline, String defaultIndent, String currentIndent, io.github.mmm.code.api.language.CodeLanguage language)
BasePathElements	getChildren()
BaseContext	getContext()
io.github.mmm.code.api.node.CodeContainer	getParent()
Package	getReflectiveObject()
BaseSource	getSource()
BasePackage	getSourceCodeObject()
boolean	isFile()
boolean	isJava()
boolean	isJavaLang()
boolean	isRequireImport()
boolean	isRoot()
protected boolean	isSystemImmutable()
void	write(Path targetFolder)
void	write(Path targetFolder, Charset encoding)

Methods inherited from class BasePathElement

doSetParentPackage, removeFromParent

Methods inherited from class BaseElementWithQualifiedName

getParentPackage, getQualifiedName, getSimpleName, setParentPackage, setSimpleName

Methods inherited from class BaseElement

doInitialize, doMerge, doWriteAnnotations, doWriteComment, doWriteDoc, getAnnotations, getComment, getDoc, setComment

Methods inherited from class BaseNodeItem

getContainerItem, getContainerItemDeclared, getLanguage, toPathString

Methods inherited from class BaseMutableItem

doCopyNode, doCopyNodeUnsafe, doMapList, doneInitialize, getDefaultCopyMapper, getDefaultEncoding, initialize, initialize, isImmutable, isInitialized, isInitializing, isSystemImmutable, makeImmutable, makeImmutable, setImmutable, setImmutableIfNotSystemImmutable, verifyMutalbe, writeItem

Methods inherited from class BaseItem

getOwningType, getSourceCode, getSpaces, toString, write

Methods inherited from class Object

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

Methods inherited from interface io.github.mmm.code.api.element.CodeElement

getAnnotations, getDoc, removeFromParent

Methods inherited from interface io.github.mmm.code.api.item.CodeItem

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

Methods inherited from interface io.github.mmm.code.api.item.CodeItemWithComment

getComment

Methods inherited from interface io.github.mmm.code.api.item.CodeItemWithQualifiedName

getSimpleName

Methods inherited from interface io.github.mmm.code.api.item.CodeItemWithQualifiedNameAndParentPackage

getParentPackage, getQualifiedName

Methods inherited from interface io.github.mmm.code.api.object.CodeMutable

isImmutable, isMutable

Methods inherited from interface io.github.mmm.code.api.item.CodeMutableItem

setImmutable

Methods inherited from interface io.github.mmm.code.api.item.CodeMutableItemWithComment

setComment

Field Details

NAME_DEFAULT

public static final String NAME_DEFAULT

Simple name of the default (root) package.

See Also:

• Constant Field Values

NAME_JAVA

public static final String NAME_JAVA

Simple name "java".

See Also:

• Constant Field Values

NAME_LANG

public static final String NAME_LANG

Simple name "lang".

See Also:

• Constant Field Values

NAME_UTIL

public static final String NAME_UTIL

Simple name "util".

See Also:

• Constant Field Values

Constructor Details

BasePackage

public BasePackage(BaseSource source)

The constructor for a root package.

Parameters:

source - the source.

BasePackage

public BasePackage(BasePackage parentPackage,
 String simpleName)

The constructor.

Parameters:

parentPackage - the parent package.

simpleName - the simple name.

BasePackage

public BasePackage(BasePackage parentPackage,
 String simpleName,
 Package reflectiveObject,
 Supplier<BasePackage> sourceSupplier,
 boolean systemImmutable)

The constructor.

Parameters:

parentPackage - the parent package.

simpleName - the simple name.

reflectiveObject - the reflective object.

sourceSupplier - the optional Supplier for lazy-loading of source-code.

systemImmutable - the system immutable flag.

BasePackage

public BasePackage(BasePackage template,
 io.github.mmm.code.api.copy.CodeCopyMapper mapper)

The copy-constructor.

Parameters:

template - the BasePackage to copy.

mapper - the CodeCopyMapper.

Method Details

doSetImmutable

protected void doSetImmutable()

Description copied from class: BaseMutableItem

Called on the first call of BaseMutableItem.setImmutable(). Has to be overridden to update Collections, make child items immutable, etc.

Overrides:

doSetImmutable in class BaseElement

getParent

public io.github.mmm.code.api.node.CodeContainer getParent()

Specified by:

getParent in interface io.github.mmm.code.api.node.CodeNode

Specified by:

getParent in interface io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.node.CodeNode, io.github.mmm.code.api.CodePackage>

Specified by:

getParent in interface io.github.mmm.code.api.CodePackage

Specified by:

getParent in interface io.github.mmm.code.api.CodePathElement

getReflectiveObject

public Package getReflectiveObject()

Specified by:

getReflectiveObject in interface io.github.mmm.code.api.item.CodeMutableItem

Specified by:

getReflectiveObject in interface io.github.mmm.code.api.CodePackage

Overrides:

getReflectiveObject in class BaseMutableItem

getSourceCodeObject

public BasePackage getSourceCodeObject()

Overrides:

getSourceCodeObject in class BaseElement

Returns:

the optional internal CodeItem representing the source-code (to merge). Otherwise null. This is an internal API. Do not use or rely on it from outside.

getContext

public BaseContext getContext()

Specified by:

getContext in interface io.github.mmm.code.api.CodeWithContext

Overrides:

getContext in class BaseNodeItem

getSource

public BaseSource getSource()

Specified by:

getSource in interface io.github.mmm.code.api.CodeWithContext

Overrides:

getSource in class BaseNodeItem

isFile

public boolean isFile()

Specified by:

isFile in interface io.github.mmm.code.api.CodePathElement

getChildren

public BasePathElements getChildren()

Specified by:

getChildren in interface io.github.mmm.code.api.CodePackage

isRequireImport

public boolean isRequireImport()

Specified by:

isRequireImport in interface io.github.mmm.code.api.CodePackage

isRoot

public boolean isRoot()

Specified by:

isRoot in interface io.github.mmm.code.api.CodePackage

Returns:

true if this is the default package, false otherwise.

isJava

public boolean isJava()

Returns:

true if this is the "java" package, false otherwise.

isJavaLang

public boolean isJavaLang()

Returns:

true if this is the "java.lang" package (that requires no import), false otherwise.

isSystemImmutable

protected boolean isSystemImmutable()

Overrides:

isSystemImmutable in class BaseMutableItem

Returns:

true if this is a system internal node item that is considered to be immutable but is technically set to immutable during (lazy) initialization. Otherwise false.

copy

public BasePackage copy()

Specified by:

copy in interface io.github.mmm.code.api.element.CodeElement

Specified by:

copy in interface io.github.mmm.code.api.item.CodeMutableItem

Specified by:

copy in interface io.github.mmm.code.api.node.CodeNodeItem

Specified by:

copy in interface io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.node.CodeNode, io.github.mmm.code.api.CodePackage>

Specified by:

copy in interface io.github.mmm.code.api.CodePackage

copy

public BasePackage copy(io.github.mmm.code.api.copy.CodeCopyMapper mapper)

Specified by:

copy in interface io.github.mmm.code.api.item.CodeMutableItem

Specified by:

copy in interface io.github.mmm.code.api.node.CodeNodeItem

Specified by:

copy in interface io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.node.CodeNode, io.github.mmm.code.api.CodePackage>

doWrite

protected void doWrite(Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent,
 io.github.mmm.code.api.language.CodeLanguage language)
                throws IOException

Overrides:

doWrite in class BaseElement

Parameters:

sink - the Appendable where to append the code from this CodeItem.

newline - the newline String.

defaultIndent - the String used for indentation (e.g. a number of spaces to insert per indent level).

currentIndent - the current indent (number of spaces). Initially the empty string (""). Before a recursion the defaultIndent will be appended.

language - the CodeLanguage to use.

Throws:

IOException - if thrown by Appendable.

See Also:

• CodeItem.write(Appendable, String, String)

write

public void write(Path targetFolder)

Specified by:

write in interface io.github.mmm.code.api.node.CodeNodeWithFileWriting

write

public void write(Path targetFolder,
 Charset encoding)

Specified by:

write in interface io.github.mmm.code.api.node.CodeNodeWithFileWriting