Interface CodeFile

All Superinterfaces:

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

public interface CodeFile
extends CodePathElement, CodeNodeWithFileWriting, CodeNodeItemCopyable<CodePackage, CodeFile>

Abstract top-level interface for any item of code as defined by this API. It reflects code structure.

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
CodeFile	copy()
CodeFile	copy(CodeCopyMapper mapper)
String	getExtension()
CodeImports	getImports()
Class<?>	getReflectiveObject()
default CodeType	getType()
List<? extends CodeType>	getTypes()

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

getParent

Methods inherited from interface CodeNodeWithFileWriting

write, write

Methods inherited from interface CodePathElement

getParent, isFile

Methods inherited from interface CodeWithContext

getContext, getSource

Method Details

getExtension

String getExtension()

Returns:

the file extension including the dot (e.g. ".java").

getType

default CodeType getType()

Returns:

the main type contained in this file.

getTypes

List<? extends CodeType> getTypes()

Returns:

the List with all top-level CodeTypes contained in this file. For clean Java code this should be only one single type.

getImports

CodeImports getImports()

Returns:

the CodeImports containing the CodeImports. May be empty but is never null.

getReflectiveObject

Class<?> 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

CodeFile 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<CodePackage, CodeFile>

Returns:

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

copy

CodeFile copy(CodeCopyMapper mapper)

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemCopyable<CodePackage, CodeFile>

Parameters:

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

Returns:

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