AbstractJavaSource (Forge Roaster - JDT Implementation 2.20.0.Final API)

java.lang.Object
- org.jboss.forge.roaster.model.impl.AbstractJavaSource<O>

All Implemented Interfaces:

Internal, AnnotationTarget<O>, JavaDocCapable<O>, JavaType<O>, Named, Packaged<O>, AnnotationTargetSource<O,O>, Importer<O>, JavaDocCapableSource<O>, JavaSource<O>, NamedSource<O>, PackagedSource<O>, StaticCapableSource<O>, TypeHolderSource<O>, VisibilityScopedSource<O>, StaticCapable, TypeHolder<O>, VisibilityScoped, Origin<O>

Direct Known Subclasses:

AbstractJavaSourceMemberHolder, JavaAnnotationImpl
```
public abstract class AbstractJavaSource<O extends JavaSource<O>>
extends Object
implements JavaSource<O>, TypeHolderSource<O>, StaticCapableSource<O>
```
Represents a Java Source File

Author:

Lincoln Baxter, III

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.eclipse.jdt.core.dom.BodyDeclaration`	`body`
`protected org.eclipse.jface.text.Document`	`document`
`protected JavaSource<?>`	`enclosingType`
`protected org.eclipse.jdt.core.dom.CompilationUnit`	`unit`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractJavaSource(JavaSource<?> enclosingType, org.eclipse.jface.text.Document document, org.eclipse.jdt.core.dom.CompilationUnit unit, org.eclipse.jdt.core.dom.BodyDeclaration body)`

Method Summary

Methods
Modifier and Type	Method and Description
`AnnotationSource<O>`	`addAnnotation()`
`AnnotationSource<O>`	`addAnnotation(Class<? extends Annotation> clazz)`
`AnnotationSource<O>`	`addAnnotation(String className)`
`Import`	`addImport(Class<?> type)`
`Import`	`addImport(Import imprt)`
`Import`	`addImport(String className)`
`<T extends JavaType<?>> Import`	`addImport(T type)`
`Import`	`addImport(Type<?> type)`
`<NESTED_TYPE extends JavaSource<?>> NESTED_TYPE`	`addNestedType(Class<NESTED_TYPE> type)`
`<NESTED_TYPE extends JavaSource<?>> NESTED_TYPE`	`addNestedType(NESTED_TYPE type)`
`<NESTED_TYPE extends JavaSource<?>> NESTED_TYPE`	`addNestedType(String declaration)`
`boolean`	`equals(Object obj)`
`AnnotationSource<O>`	`getAnnotation(Class<? extends Annotation> type)`
`AnnotationSource<O>`	`getAnnotation(String type)`
`List<AnnotationSource<O>>`	`getAnnotations()`
`protected org.eclipse.jdt.core.dom.AbstractTypeDeclaration`	`getBodyDeclaration()`
`String`	`getCanonicalName()`
`JavaSource<?>`	`getEnclosingType()`
`Import`	`getImport(Class<?> type)`
`Import`	`getImport(Import imprt)`
`Import`	`getImport(String className)`
`<T extends JavaType<?>> Import`	`getImport(T type)`
`List<Import>`	`getImports()`
`Object`	`getInternal()`
`JavaDocSource<O>`	`getJavaDoc()`
`String`	`getName()`
`JavaSource<?>`	`getNestedType(String name)`
`List<JavaSource<?>>`	`getNestedTypes()`
`O`	`getOrigin()`
`String`	`getPackage()`
`String`	`getQualifiedName()`
`List<SyntaxError>`	`getSyntaxErrors()`
`Visibility`	`getVisibility()`
`boolean`	`hasAnnotation(Class<? extends Annotation> type)`
`boolean`	`hasAnnotation(String type)`
`int`	`hashCode()`
`boolean`	`hasImport(Class<?> type)`
`boolean`	`hasImport(Import imprt)`
`boolean`	`hasImport(String type)`
`<T extends JavaType<T>> boolean`	`hasImport(T type)`
`boolean`	`hasJavaDoc()`
`boolean`	`hasNestedType(Class<?> type)`
`boolean`	`hasNestedType(JavaType<?> type)`
`boolean`	`hasNestedType(String name)`
`boolean`	`hasSyntaxErrors()`
`boolean`	`isAnnotation()`
`boolean`	`isClass()`
`boolean`	`isDefaultPackage()`
`boolean`	`isEnum()`
`boolean`	`isInterface()`
`boolean`	`isPackagePrivate()`
`boolean`	`isPrivate()`
`boolean`	`isProtected()`
`boolean`	`isPublic()`
`boolean`	`isStatic()`
`void`	`removeAllAnnotations()`
`O`	`removeAnnotation(Annotation<O> annotation)`
`O`	`removeImport(Class<?> clazz)`
`O`	`removeImport(Import imprt)`
`O`	`removeImport(String name)`
`<T extends JavaType<?>> O`	`removeImport(T type)`
`O`	`removeJavaDoc()`
`O`	`removeNestedType(JavaSource<?> type)`
`boolean`	`requiresImport(Class<?> type)`
`boolean`	`requiresImport(String type)`
`String`	`resolveType(String type)`
`O`	`setDefaultPackage()`
`O`	`setName(String name)`
`O`	`setPackage(String name)`
`O`	`setPackagePrivate()`
`O`	`setPrivate()`
`O`	`setProtected()`
`O`	`setPublic()`
`O`	`setStatic(boolean _static)`
`O`	`setVisibility(Visibility scope)`
`String`	`toString()` Return this `JavaType` file as a String
`String`	`toUnformattedString()`
`protected abstract O`	`updateTypeNames(String name)` Call-back to allow updating of any necessary internal names with the given name.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - document
```
protected final org.eclipse.jface.text.Document document
```
  - unit
```
protected final org.eclipse.jdt.core.dom.CompilationUnit unit
```
  - body
```
protected final org.eclipse.jdt.core.dom.BodyDeclaration body
```
  - enclosingType
```
protected final JavaSource<?> enclosingType
```
- Constructor Detail
  - AbstractJavaSource
```
protected AbstractJavaSource(JavaSource<?> enclosingType,
                  org.eclipse.jface.text.Document document,
                  org.eclipse.jdt.core.dom.CompilationUnit unit,
                  org.eclipse.jdt.core.dom.BodyDeclaration body)
```
- Method Detail
  - getEnclosingType
```
public JavaSource<?> getEnclosingType()
```
    Specified by:
    
    getEnclosingType in interface JavaType<O extends JavaSource<O>>
    
    Specified by:
    
    getEnclosingType in interface JavaSource<O extends JavaSource<O>>
  - addAnnotation
```
public AnnotationSource<O> addAnnotation()
```
    Specified by:
    
    addAnnotation in interface AnnotationTargetSource<O extends JavaSource<O>,O extends JavaSource<O>>
  - addAnnotation
```
public AnnotationSource<O> addAnnotation(Class<? extends Annotation> clazz)
```
    Specified by:
    
    addAnnotation in interface AnnotationTargetSource<O extends JavaSource<O>,O extends JavaSource<O>>
  - addAnnotation
```
public AnnotationSource<O> addAnnotation(String className)
```
    Specified by:
    
    addAnnotation in interface AnnotationTargetSource<O extends JavaSource<O>,O extends JavaSource<O>>
  - getAnnotations
```
public List<AnnotationSource<O>> getAnnotations()
```
    Specified by:
    
    getAnnotations in interface AnnotationTarget<O extends JavaSource<O>>
    
    Specified by:
    
    getAnnotations in interface AnnotationTargetSource<O extends JavaSource<O>,O extends JavaSource<O>>
  - hasAnnotation
```
public boolean hasAnnotation(Class<? extends Annotation> type)
```
    Specified by:
    
    hasAnnotation in interface AnnotationTarget<O extends JavaSource<O>>
  - hasAnnotation
```
public boolean hasAnnotation(String type)
```
    Specified by:
    
    hasAnnotation in interface AnnotationTarget<O extends JavaSource<O>>
  - removeAnnotation
```
public O removeAnnotation(Annotation<O> annotation)
```
    Specified by:
    
    removeAnnotation in interface AnnotationTargetSource<O extends JavaSource<O>,O extends JavaSource<O>>
  - removeAllAnnotations
```
public void removeAllAnnotations()
```
    Specified by:
    
    removeAllAnnotations in interface AnnotationTargetSource<O extends JavaSource<O>,O extends JavaSource<O>>
  - getAnnotation
```
public AnnotationSource<O> getAnnotation(Class<? extends Annotation> type)
```
    Specified by:
    
    getAnnotation in interface AnnotationTarget<O extends JavaSource<O>>
    
    Specified by:
    
    getAnnotation in interface AnnotationTargetSource<O extends JavaSource<O>,O extends JavaSource<O>>
  - getAnnotation
```
public AnnotationSource<O> getAnnotation(String type)
```
    Specified by:
    
    getAnnotation in interface AnnotationTarget<O extends JavaSource<O>>
    
    Specified by:
    
    getAnnotation in interface AnnotationTargetSource<O extends JavaSource<O>,O extends JavaSource<O>>
  - addImport
```
public Import addImport(Class<?> type)
```
    Specified by:
    
    addImport in interface Importer<O extends JavaSource<O>>
  - addImport
```
public <T extends JavaType<?>> Import addImport(T type)
```
    Specified by:
    
    addImport in interface Importer<O extends JavaSource<O>>
  - addImport
```
public Import addImport(Import imprt)
```
    Specified by:
    
    addImport in interface Importer<O extends JavaSource<O>>
  - addImport
```
public Import addImport(String className)
```
    Specified by:
    
    addImport in interface Importer<O extends JavaSource<O>>
  - getImport
```
public Import getImport(String className)
```
    Specified by:
    
    getImport in interface Importer<O extends JavaSource<O>>
  - getImport
```
public Import getImport(Class<?> type)
```
    Specified by:
    
    getImport in interface Importer<O extends JavaSource<O>>
  - getImport
```
public <T extends JavaType<?>> Import getImport(T type)
```
    Specified by:
    
    getImport in interface Importer<O extends JavaSource<O>>
  - getImport
```
public Import getImport(Import imprt)
```
    Specified by:
    
    getImport in interface Importer<O extends JavaSource<O>>
  - getImports
```
public List<Import> getImports()
```
    Specified by:
    
    getImports in interface Importer<O extends JavaSource<O>>
  - hasImport
```
public boolean hasImport(Class<?> type)
```
    Specified by:
    
    hasImport in interface Importer<O extends JavaSource<O>>
  - hasImport
```
public <T extends JavaType<T>> boolean hasImport(T type)
```
    Specified by:
    
    hasImport in interface Importer<O extends JavaSource<O>>
  - hasImport
```
public boolean hasImport(Import imprt)
```
    Specified by:
    
    hasImport in interface Importer<O extends JavaSource<O>>
  - hasImport
```
public boolean hasImport(String type)
```
    Specified by:
    
    hasImport in interface Importer<O extends JavaSource<O>>
  - requiresImport
```
public boolean requiresImport(Class<?> type)
```
    Specified by:
    
    requiresImport in interface Importer<O extends JavaSource<O>>
  - requiresImport
```
public boolean requiresImport(String type)
```
    Specified by:
    
    requiresImport in interface Importer<O extends JavaSource<O>>
  - resolveType
```
public String resolveType(String type)
```
    Specified by:
    
    resolveType in interface Importer<O extends JavaSource<O>>
  - removeImport
```
public O removeImport(String name)
```
    Specified by:
    
    removeImport in interface Importer<O extends JavaSource<O>>
  - removeImport
```
public O removeImport(Class<?> clazz)
```
    Specified by:
    
    removeImport in interface Importer<O extends JavaSource<O>>
  - removeImport
```
public <T extends JavaType<?>> O removeImport(T type)
```
    Specified by:
    
    removeImport in interface Importer<O extends JavaSource<O>>
  - removeImport
```
public O removeImport(Import imprt)
```
    Specified by:
    
    removeImport in interface Importer<O extends JavaSource<O>>
  - getBodyDeclaration
```
protected org.eclipse.jdt.core.dom.AbstractTypeDeclaration getBodyDeclaration()
```
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Named
  - setName
```
public O setName(String name)
```
    Specified by:
    
    setName in interface NamedSource<O extends JavaSource<O>>
  - getCanonicalName
```
public String getCanonicalName()
```
    Specified by:
    
    getCanonicalName in interface JavaType<O extends JavaSource<O>>
  - updateTypeNames
```
protected abstract O updateTypeNames(String name)
```
    Call-back to allow updating of any necessary internal names with the given name.
  - getQualifiedName
```
public String getQualifiedName()
```
    Specified by:
    
    getQualifiedName in interface JavaType<O extends JavaSource<O>>
  - getPackage
```
public String getPackage()
```
    Specified by:
    
    getPackage in interface Packaged<O extends JavaSource<O>>
  - setPackage
```
public O setPackage(String name)
```
    Specified by:
    
    setPackage in interface PackagedSource<O extends JavaSource<O>>
  - setDefaultPackage
```
public O setDefaultPackage()
```
    Specified by:
    
    setDefaultPackage in interface PackagedSource<O extends JavaSource<O>>
  - isDefaultPackage
```
public boolean isDefaultPackage()
```
    Specified by:
    
    isDefaultPackage in interface Packaged<O extends JavaSource<O>>
  - isPackagePrivate
```
public boolean isPackagePrivate()
```
    Specified by:
    
    isPackagePrivate in interface VisibilityScoped
  - setPackagePrivate
```
public O setPackagePrivate()
```
    Specified by:
    
    setPackagePrivate in interface VisibilityScopedSource<O extends JavaSource<O>>
  - isPublic
```
public boolean isPublic()
```
    Specified by:
    
    isPublic in interface VisibilityScoped
  - setPublic
```
public O setPublic()
```
    Specified by:
    
    setPublic in interface VisibilityScopedSource<O extends JavaSource<O>>
  - isPrivate
```
public boolean isPrivate()
```
    Specified by:
    
    isPrivate in interface VisibilityScoped
  - setPrivate
```
public O setPrivate()
```
    Specified by:
    
    setPrivate in interface VisibilityScopedSource<O extends JavaSource<O>>
  - isProtected
```
public boolean isProtected()
```
    Specified by:
    
    isProtected in interface VisibilityScoped
  - setProtected
```
public O setProtected()
```
    Specified by:
    
    setProtected in interface VisibilityScopedSource<O extends JavaSource<O>>
  - getVisibility
```
public Visibility getVisibility()
```
    Specified by:
    
    getVisibility in interface VisibilityScoped
  - setVisibility
```
public O setVisibility(Visibility scope)
```
    Specified by:
    
    setVisibility in interface VisibilityScopedSource<O extends JavaSource<O>>
  - toString
```
public String toString()
```
    Return this JavaType file as a String
    
    Overrides:
    
    toString in class Object
  - toUnformattedString
```
public String toUnformattedString()
```
    Specified by:
    
    toUnformattedString in interface JavaType<O extends JavaSource<O>>
  - getInternal
```
public Object getInternal()
```
    Specified by:
    
    getInternal in interface Internal
  - getOrigin
```
public O getOrigin()
```
    Specified by:
    
    getOrigin in interface Origin<O extends JavaSource<O>>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getSyntaxErrors
```
public List<SyntaxError> getSyntaxErrors()
```
    Specified by:
    
    getSyntaxErrors in interface JavaType<O extends JavaSource<O>>
  - hasSyntaxErrors
```
public boolean hasSyntaxErrors()
```
    Specified by:
    
    hasSyntaxErrors in interface JavaType<O extends JavaSource<O>>
  - isClass
```
public boolean isClass()
```
    Specified by:
    
    isClass in interface JavaType<O extends JavaSource<O>>
  - isEnum
```
public boolean isEnum()
```
    Specified by:
    
    isEnum in interface JavaType<O extends JavaSource<O>>
  - isInterface
```
public boolean isInterface()
```
    Specified by:
    
    isInterface in interface JavaType<O extends JavaSource<O>>
  - isAnnotation
```
public boolean isAnnotation()
```
    Specified by:
    
    isAnnotation in interface JavaType<O extends JavaSource<O>>
  - getNestedTypes
```
public List<JavaSource<?>> getNestedTypes()
```
    Specified by:
    
    getNestedTypes in interface TypeHolderSource<O extends JavaSource<O>>
    
    Specified by:
    
    getNestedTypes in interface TypeHolder<O extends JavaSource<O>>
  - hasNestedType
```
public boolean hasNestedType(JavaType<?> type)
```
    Specified by:
    
    hasNestedType in interface TypeHolder<O extends JavaSource<O>>
  - hasNestedType
```
public boolean hasNestedType(String name)
```
    Specified by:
    
    hasNestedType in interface TypeHolder<O extends JavaSource<O>>
  - hasNestedType
```
public boolean hasNestedType(Class<?> type)
```
    Specified by:
    
    hasNestedType in interface TypeHolder<O extends JavaSource<O>>
  - getNestedType
```
public JavaSource<?> getNestedType(String name)
```
    Specified by:
    
    getNestedType in interface TypeHolderSource<O extends JavaSource<O>>
    
    Specified by:
    
    getNestedType in interface TypeHolder<O extends JavaSource<O>>
  - addNestedType
```
public <NESTED_TYPE extends JavaSource<?>> NESTED_TYPE addNestedType(NESTED_TYPE type)
```
    Specified by:
    
    addNestedType in interface TypeHolderSource<O extends JavaSource<O>>
  - removeNestedType
```
public O removeNestedType(JavaSource<?> type)
```
    Specified by:
    
    removeNestedType in interface TypeHolderSource<O extends JavaSource<O>>
  - addNestedType
```
public <NESTED_TYPE extends JavaSource<?>> NESTED_TYPE addNestedType(Class<NESTED_TYPE> type)
```
    Specified by:
    
    addNestedType in interface TypeHolderSource<O extends JavaSource<O>>
  - addNestedType
```
public <NESTED_TYPE extends JavaSource<?>> NESTED_TYPE addNestedType(String declaration)
```
    Specified by:
    
    addNestedType in interface TypeHolderSource<O extends JavaSource<O>>
  - getJavaDoc
```
public JavaDocSource<O> getJavaDoc()
```
    Specified by:
    
    getJavaDoc in interface JavaDocCapable<O extends JavaSource<O>>
    
    Specified by:
    
    getJavaDoc in interface JavaDocCapableSource<O extends JavaSource<O>>
  - removeJavaDoc
```
public O removeJavaDoc()
```
    Specified by:
    
    removeJavaDoc in interface JavaDocCapableSource<O extends JavaSource<O>>
  - hasJavaDoc
```
public boolean hasJavaDoc()
```
    Specified by:
    
    hasJavaDoc in interface JavaDocCapable<O extends JavaSource<O>>
  - isStatic
```
public boolean isStatic()
```
    Specified by:
    
    isStatic in interface StaticCapable
  - setStatic
```
public O setStatic(boolean _static)
```
    Specified by:
    
    setStatic in interface StaticCapableSource<O extends JavaSource<O>>
  - addImport
```
public Import addImport(Type<?> type)
```
    Specified by:
    
    addImport in interface Importer<O extends JavaSource<O>>

Class AbstractJavaSource<O extends JavaSource<O>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

document

unit

body

enclosingType

Constructor Detail

AbstractJavaSource

Method Detail

getEnclosingType

addAnnotation

addAnnotation

addAnnotation

getAnnotations

hasAnnotation

hasAnnotation

removeAnnotation

removeAllAnnotations

getAnnotation

getAnnotation

addImport

addImport

addImport

addImport

getImport

getImport

getImport

getImport

getImports

hasImport

hasImport

hasImport

hasImport

requiresImport

requiresImport

resolveType

removeImport

removeImport

removeImport

removeImport

getBodyDeclaration

getName

setName

getCanonicalName

updateTypeNames

getQualifiedName

getPackage

setPackage

setDefaultPackage

isDefaultPackage

isPackagePrivate

setPackagePrivate

isPublic

setPublic

isPrivate

setPrivate

isProtected

setProtected

getVisibility

setVisibility

toString

toUnformattedString

getInternal

getOrigin

hashCode

equals

getSyntaxErrors

hasSyntaxErrors

isClass

isEnum

isInterface

isAnnotation

getNestedTypes

hasNestedType

hasNestedType

hasNestedType