org.jboss.forge.parser.java

Interface JavaSource<T extends JavaSource<T>>

All Superinterfaces:

AnnotationTarget<T,T>, Importer<T>, Internal, MemberHolder<T,Member>, Named<T>, Origin<T>, Packaged<T>, VisibilityScoped<T>

All Known Subinterfaces:

EnumConstant.Body, JavaAnnotation, JavaClass, JavaEnum, JavaInterface, JavaPackageInfo, JavaType<T>

public interface JavaSource<T extends JavaSource<T>>
extends Packaged<T>, Importer<T>, Named<T>, VisibilityScoped<T>, AnnotationTarget<T,T>, MemberHolder<T,Member>, Origin<T>

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
String	getCanonicalName() Return the canonical name of this T instance.
JavaSource<?>	getEnclosingType() Return the enclosing JavaSource type in which this class is defined.
List<JavaSource<?>>	getNestedClasses() Return a list containing JavaSource instances for each nested Class declaration found within this.
String	getQualifiedName() Get the qualified-name of this T instance, where the qualified-name contains both the Java package and simple class name of the type represented by this T instance.
SourceType	getSourceType() Return the SourceType of this JavaSource instance.
List<SyntaxError>	getSyntaxErrors() Get a list of all SyntaxErrors detected in the current T.
boolean	hasSyntaxErrors() Return whether or not this T currently has any SyntaxError s.
boolean	isAnnotation() Return true if this JavaSource represents a JavaAnnotation
boolean	isClass() Return true if this JavaSource represents a JavaClass
boolean	isEnum() Return true if this JavaSource represents a JavaEnum
boolean	isInterface() Return true if this JavaSource represents a JavaClass interface.

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

getPackage, isDefaultPackage, setDefaultPackage, setPackage

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

addImport, addImport, addImport, addImport, getImport, getImport, getImport, getImport, getImports, hasImport, hasImport, hasImport, hasImport, removeImport, removeImport, removeImport, removeImport, requiresImport, requiresImport, resolveType

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

getName, setName

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

getVisibility, isPackagePrivate, isPrivate, isProtected, isPublic, setPackagePrivate, setPrivate, setProtected, setPublic, setVisibility

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

addAnnotation, addAnnotation, addAnnotation, getAnnotation, getAnnotation, getAnnotations, hasAnnotation, hasAnnotation, removeAnnotation

Methods inherited from interface org.jboss.forge.parser.Internal

getInternal

Methods inherited from interface org.jboss.forge.parser.Origin

getOrigin

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

getMembers

Method Detail

getCanonicalName

String getCanonicalName()

Return the canonical name of this T instance. This is equivalent to calling Class.getCanonicalName()

getQualifiedName

String getQualifiedName()

Get the qualified-name of this T instance, where the qualified-name contains both the Java package and simple class name of the type represented by this T instance.

For example, calling: getQualifiedName() is equivalent to calling "Packaged.getPackage() + "." + Named.getName()", which in turn is equivalent to calling: Class.getName()

getSyntaxErrors

List<SyntaxError> getSyntaxErrors()

Get a list of all SyntaxErrors detected in the current T. Note that when errors are present, the class may still be modified, but changes may not be completely accurate.

hasSyntaxErrors

boolean hasSyntaxErrors()

Return whether or not this T currently has any SyntaxError s.

isClass

boolean isClass()

Return true if this JavaSource represents a JavaClass

isEnum

boolean isEnum()

Return true if this JavaSource represents a JavaEnum

isInterface

boolean isInterface()

Return true if this JavaSource represents a JavaClass interface.

isAnnotation

boolean isAnnotation()

Return true if this JavaSource represents a JavaAnnotation

getEnclosingType

JavaSource<?> getEnclosingType()

Return the enclosing JavaSource type in which this class is defined. If this class is a top-level type, and is not a nested type, this object will return itself.

getNestedClasses

List<JavaSource<?>> getNestedClasses()

Return a list containing JavaSource instances for each nested Class declaration found within this. Any modification of returned JavaSource instances will result in modification of the contents contained by this the parent instance.

getSourceType

SourceType getSourceType()

Return the SourceType of this JavaSource instance.