Interface CodePackage

All Superinterfaces:

CodeContainer, CodeElement, CodeItem, CodeItemWithComment, CodeItemWithQualifiedName, CodeItemWithQualifiedNameAndParentPackage, CodeMutable, CodeMutableItem, CodeMutableItemWithComment, CodeNode, CodeNodeItem, CodeNodeItemCopyable<CodeNode, CodePackage>, CodeNodeWithFileWriting, CodePathElement, CodeWithContext

public interface CodePackage
extends CodePathElement, CodeContainer, CodeNodeWithFileWriting, CodeNodeItemCopyable<CodeNode, CodePackage>

CodeElement representing a Package (or similar namespace concept in case of other language).

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
CodePackage	copy()
CodePathElements	getChildren()
CodeContainer	getParent()	The parent package or the source if this is a root package.
Package	getReflectiveObject()
boolean	isRequireImport()
boolean	isRoot()

Methods inherited from interface CodeElement

getAnnotations, getDoc, removeFromParent

Methods inherited from interface CodeItem

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

Methods inherited from interface CodeItemWithComment

getComment

Methods inherited from interface CodeItemWithQualifiedName

getSimpleName

Methods inherited from interface CodeItemWithQualifiedNameAndParentPackage

getParentPackage, getQualifiedName

Methods inherited from interface CodeMutable

isImmutable, isMutable

Methods inherited from interface CodeMutableItem

setImmutable

Methods inherited from interface CodeMutableItemWithComment

setComment

Methods inherited from interface CodeNodeItemCopyable

copy

Methods inherited from interface CodeNodeWithFileWriting

write, write

Methods inherited from interface CodePathElement

isFile

Methods inherited from interface CodeWithContext

getContext, getSource

Method Details

getParent

CodeContainer getParent()

The parent package or the source if this is a root package.

Specified by:

getParent in interface CodeNode

Specified by:

getParent in interface CodeNodeItemCopyable<CodeNode, CodePackage>

Specified by:

getParent in interface CodePathElement

Returns:

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

getChildren

CodePathElements getChildren()

Returns:

the CodePathElements containing the child CodePackages and CodeFiles of this package.

isRequireImport

boolean isRequireImport()

Returns:

true if this a regular package that requires an import, false otherwise (in case of a standard package that is always visible such as "{java.lang" for Java).

isRoot

boolean isRoot()

Returns:

true if this is the root package (called "default package" in Java), false otherwise.

getReflectiveObject

Package getReflectiveObject()

Specified by:

getReflectiveObject in interface CodeMutableItem

Returns:

the optional reflective object of this item such as Class. May be null (e.g. if this object was created from source-code only or has been created dynamically). However, if available it can be helpful for analysis especially in case of type-safe Annotation processing. In most cases the generic type will be derived from AnnotatedElement but in specific cases it can also be ProtectionDomain or other types that have no common parent-type. Therefore this generic type is unbounded here.

copy

CodePackage copy()

Specified by:

copy in interface CodeElement

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemCopyable<CodeNode, CodePackage>

Returns:

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