AbstractJavaSource (Forge - Java Parser Implementation 1.0.0.Final API)

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

All Implemented Interfaces:

Internal, AnnotationTarget<O,O>, Importer<O>, InterfaceCapable<O>, JavaSource<O>, MemberHolder<O,Member>, Named<O>, Packaged<O>, VisibilityScoped<O>, Origin<O>

Direct Known Subclasses:

AbstractJavaSourceMemberHolder, JavaAnnotationImpl
```
public abstract class AbstractJavaSource<O extends JavaSource<O>>
extends Object
implements JavaSource<O>, InterfaceCapable<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`
`static ServiceLoader<WildcardImportResolver>`	`loader`
`protected org.eclipse.jdt.core.dom.CompilationUnit`	`unit`

Constructor Summary

Constructors
Constructor and Description
`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
`Annotation<O>`	`addAnnotation()`
`Annotation<O>`	`addAnnotation(Class<? extends Annotation> clazz)`
`Annotation<O>`	`addAnnotation(String className)`
`Import`	`addImport(Class<?> type)`
`Import`	`addImport(Import imprt)`
`Import`	`addImport(String className)`
`<T extends JavaSource<?>> Import`	`addImport(T type)`
`O`	`addInterface(Class<?> type)`
`O`	`addInterface(JavaInterface type)`
`O`	`addInterface(String type)`
`boolean`	`equals(Object obj)`
`Annotation<O>`	`getAnnotation(Class<? extends Annotation> type)`
`Annotation<O>`	`getAnnotation(String type)`
`List<Annotation<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 JavaSource<?>> Import`	`getImport(T type)`
`List<Import>`	`getImports()`
`List<String>`	`getInterfaces()`
`Object`	`getInternal()`
`List<Member<O,?>>`	`getMembers()`
`String`	`getName()`
`List<JavaSource<?>>`	`getNestedClasses()`
`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 JavaSource<T>> boolean`	`hasImport(T type)`
`boolean`	`hasInterface(Class<?> type)`
`boolean`	`hasInterface(JavaInterface type)`
`boolean`	`hasInterface(String type)`
`boolean`	`hasSyntaxErrors()`
`boolean`	`isAnnotation()`
`boolean`	`isClass()`
`boolean`	`isDefaultPackage()`
`boolean`	`isEnum()`
`boolean`	`isInterface()`
`boolean`	`isPackagePrivate()`
`boolean`	`isPrivate()`
`boolean`	`isProtected()`
`boolean`	`isPublic()`
`O`	`removeAnnotation(Annotation<O> annotation)`
`O`	`removeImport(Class<?> clazz)`
`O`	`removeImport(Import imprt)`
`O`	`removeImport(String name)`
`<T extends JavaSource<?>> O`	`removeImport(T type)`
`O`	`removeInterface(Class<?> type)`
`O`	`removeInterface(JavaInterface type)`
`O`	`removeInterface(String 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`	`setVisibility(Visibility scope)`
`String`	`toString()` Return this `JavaSource` file as a String
`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

Methods inherited from interface org.jboss.forge.parser.java.JavaSource
getSourceType

- 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
```
  - loader
```
public static ServiceLoader<WildcardImportResolver> loader
```
- Constructor Detail
  - AbstractJavaSource
```
public 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 JavaSource<O extends JavaSource<O>>
  - addAnnotation
```
public Annotation<O> addAnnotation()
```
    Specified by:
    
    addAnnotation in interface AnnotationTarget<O extends JavaSource<O>,O extends JavaSource<O>>
  - addAnnotation
```
public Annotation<O> addAnnotation(Class<? extends Annotation> clazz)
```
    Specified by:
    
    addAnnotation in interface AnnotationTarget<O extends JavaSource<O>,O extends JavaSource<O>>
  - addAnnotation
```
public Annotation<O> addAnnotation(String className)
```
    Specified by:
    
    addAnnotation in interface AnnotationTarget<O extends JavaSource<O>,O extends JavaSource<O>>
  - getAnnotations
```
public List<Annotation<O>> getAnnotations()
```
    Specified by:
    
    getAnnotations in interface AnnotationTarget<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>,O extends JavaSource<O>>
  - hasAnnotation
```
public boolean hasAnnotation(String type)
```
    Specified by:
    
    hasAnnotation in interface AnnotationTarget<O extends JavaSource<O>,O extends JavaSource<O>>
  - removeAnnotation
```
public O removeAnnotation(Annotation<O> annotation)
```
    Specified by:
    
    removeAnnotation in interface AnnotationTarget<O extends JavaSource<O>,O extends JavaSource<O>>
  - getAnnotation
```
public Annotation<O> getAnnotation(Class<? extends Annotation> type)
```
    Specified by:
    
    getAnnotation in interface AnnotationTarget<O extends JavaSource<O>,O extends JavaSource<O>>
  - getAnnotation
```
public Annotation<O> getAnnotation(String type)
```
    Specified by:
    
    getAnnotation in interface AnnotationTarget<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 JavaSource<?>> 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 JavaSource<?>> 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 JavaSource<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 JavaSource<?>> 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>>
  - getMembers
```
public List<Member<O,?>> getMembers()
```
    Specified by:
    
    getMembers in interface MemberHolder<O extends JavaSource<O>,Member>
  - getBodyDeclaration
```
protected org.eclipse.jdt.core.dom.AbstractTypeDeclaration getBodyDeclaration()
```
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Named<O extends JavaSource<O>>
  - setName
```
public O setName(String name)
```
    Specified by:
    
    setName in interface Named<O extends JavaSource<O>>
  - getCanonicalName
```
public String getCanonicalName()
```
    Specified by:
    
    getCanonicalName in interface JavaSource<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 JavaSource<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 Packaged<O extends JavaSource<O>>
  - setDefaultPackage
```
public O setDefaultPackage()
```
    Specified by:
    
    setDefaultPackage in interface Packaged<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<O extends JavaSource<O>>
  - setPackagePrivate
```
public O setPackagePrivate()
```
    Specified by:
    
    setPackagePrivate in interface VisibilityScoped<O extends JavaSource<O>>
  - isPublic
```
public boolean isPublic()
```
    Specified by:
    
    isPublic in interface VisibilityScoped<O extends JavaSource<O>>
  - setPublic
```
public O setPublic()
```
    Specified by:
    
    setPublic in interface VisibilityScoped<O extends JavaSource<O>>
  - isPrivate
```
public boolean isPrivate()
```
    Specified by:
    
    isPrivate in interface VisibilityScoped<O extends JavaSource<O>>
  - setPrivate
```
public O setPrivate()
```
    Specified by:
    
    setPrivate in interface VisibilityScoped<O extends JavaSource<O>>
  - isProtected
```
public boolean isProtected()
```
    Specified by:
    
    isProtected in interface VisibilityScoped<O extends JavaSource<O>>
  - setProtected
```
public O setProtected()
```
    Specified by:
    
    setProtected in interface VisibilityScoped<O extends JavaSource<O>>
  - getVisibility
```
public Visibility getVisibility()
```
    Specified by:
    
    getVisibility in interface VisibilityScoped<O extends JavaSource<O>>
  - setVisibility
```
public O setVisibility(Visibility scope)
```
    Specified by:
    
    setVisibility in interface VisibilityScoped<O extends JavaSource<O>>
  - toString
```
public String toString()
```
    Return this JavaSource file as a String
    
    Overrides:
    
    toString in class Object
  - 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 JavaSource<O extends JavaSource<O>>
  - hasSyntaxErrors
```
public boolean hasSyntaxErrors()
```
    Specified by:
    
    hasSyntaxErrors in interface JavaSource<O extends JavaSource<O>>
  - isClass
```
public boolean isClass()
```
    Specified by:
    
    isClass in interface JavaSource<O extends JavaSource<O>>
  - isEnum
```
public boolean isEnum()
```
    Specified by:
    
    isEnum in interface JavaSource<O extends JavaSource<O>>
  - isInterface
```
public boolean isInterface()
```
    Specified by:
    
    isInterface in interface JavaSource<O extends JavaSource<O>>
  - isAnnotation
```
public boolean isAnnotation()
```
    Specified by:
    
    isAnnotation in interface JavaSource<O extends JavaSource<O>>
  - getInterfaces
```
public List<String> getInterfaces()
```
    Specified by:
    
    getInterfaces in interface InterfaceCapable<O extends JavaSource<O>>
  - addInterface
```
public O addInterface(String type)
```
    Specified by:
    
    addInterface in interface InterfaceCapable<O extends JavaSource<O>>
  - addInterface
```
public O addInterface(Class<?> type)
```
    Specified by:
    
    addInterface in interface InterfaceCapable<O extends JavaSource<O>>
  - addInterface
```
public O addInterface(JavaInterface type)
```
    Specified by:
    
    addInterface in interface InterfaceCapable<O extends JavaSource<O>>
  - hasInterface
```
public boolean hasInterface(String type)
```
    Specified by:
    
    hasInterface in interface InterfaceCapable<O extends JavaSource<O>>
  - hasInterface
```
public boolean hasInterface(Class<?> type)
```
    Specified by:
    
    hasInterface in interface InterfaceCapable<O extends JavaSource<O>>
  - hasInterface
```
public boolean hasInterface(JavaInterface type)
```
    Specified by:
    
    hasInterface in interface InterfaceCapable<O extends JavaSource<O>>
  - removeInterface
```
public O removeInterface(String type)
```
    Specified by:
    
    removeInterface in interface InterfaceCapable<O extends JavaSource<O>>
  - removeInterface
```
public O removeInterface(Class<?> type)
```
    Specified by:
    
    removeInterface in interface InterfaceCapable<O extends JavaSource<O>>
  - removeInterface
```
public O removeInterface(JavaInterface type)
```
    Specified by:
    
    removeInterface in interface InterfaceCapable<O extends JavaSource<O>>
  - getNestedClasses
```
public List<JavaSource<?>> getNestedClasses()
```
    Specified by:
    
    getNestedClasses in interface JavaSource<O extends JavaSource<O>>

Class AbstractJavaSource<O extends JavaSource<O>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jboss.forge.parser.java.JavaSource

Field Detail

document

unit

body

enclosingType

loader

Constructor Detail

AbstractJavaSource

Method Detail

getEnclosingType

addAnnotation

addAnnotation

addAnnotation

getAnnotations

hasAnnotation

hasAnnotation

removeAnnotation

getAnnotation

getAnnotation

addImport

addImport

addImport

addImport

getImport

getImport

getImport

getImport

getImports

hasImport

hasImport

hasImport

hasImport

requiresImport

requiresImport

resolveType

removeImport

removeImport

removeImport

removeImport

getMembers

getBodyDeclaration

getName

setName

getCanonicalName

updateTypeNames

getQualifiedName

getPackage

setPackage

setDefaultPackage

isDefaultPackage

isPackagePrivate

setPackagePrivate

isPublic

setPublic

isPrivate

setPrivate

isProtected

setProtected

getVisibility

setVisibility

toString

getInternal

getOrigin

hashCode

equals

getSyntaxErrors

hasSyntaxErrors

isClass

isEnum

isInterface

isAnnotation

getInterfaces

addInterface

addInterface