Symbol (Javac compiler 0.10 API)

java.lang.Object
- com.sun.tools.javac.code.AnnoConstruct
- - com.sun.tools.javac.code.Symbol

All Implemented Interfaces:

AnnotatedConstruct, Element

Direct Known Subclasses:

Symbol.DelegatedSymbol, Symbol.MethodSymbol, Symbol.TypeSymbol, Symbol.VarSymbol
```
public abstract class Symbol
extends AnnoConstruct
implements Element
```
Root class for Java symbols. It contains subclasses for specific sorts of symbols, such as variables, methods and operators, types, packages. Each subclass is represented as a static inner class inside Symbol.
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Symbol.ClassSymbol` A class for class symbols
`static interface`	`Symbol.Completer` Symbol completer interface.
`static class`	`Symbol.CompletionFailure`
`static class`	`Symbol.DelegatedSymbol<T extends Symbol>`
`static class`	`Symbol.DynamicMethodSymbol` A class for invokedynamic method calls.
`static class`	`Symbol.MethodSymbol` A class for method symbols.
`static class`	`Symbol.OperatorSymbol` A class for predefined operators.
`static class`	`Symbol.PackageSymbol` A class for package symbols
`static class`	`Symbol.TypeSymbol` A base class for Symbols representing types.
`static class`	`Symbol.TypeVariableSymbol` Type variables are represented by instances of this class.
`static class`	`Symbol.VarSymbol` A class for variable symbols
`static interface`	`Symbol.Visitor<R,P>` A visitor for symbols.

Field Summary

Fields
Modifier and Type	Field and Description
`Symbol.Completer`	`completer` The completer of this symbol.
`Type`	`erasure_field` A cache for the type erasure of this symbol.
`long`	`flags_field` The flags of this symbol.
`int`	`kind` The kind of this symbol.
`protected SymbolMetadata`	`metadata` The attributes of this symbol are contained in this SymbolMetadata.
`Name`	`name` The name of this symbol in Utf8 representation.
`Symbol`	`owner` The owner of this symbol.
`Type`	`type` The type of this symbol.

Constructor Summary

Constructors
Constructor and Description
`Symbol(int kind, long flags, Name name, Type type, Symbol owner)` Construct a symbol with given kind, flags, name, type and owner.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<R,P> R`	`accept(Symbol.Visitor<R,P> v, P p)`
`boolean`	`annotationsPendingCompletion()`
`void`	`appendAttributes(List<Attribute.Compound> l)`
`void`	`appendClassInitTypeAttributes(List<Attribute.TypeCompound> l)`
`void`	`appendInitTypeAttributes(List<Attribute.TypeCompound> l)`
`void`	`appendTypeAttributesWithCompletion(Annotate.AnnotateRepeatedContext<Attribute.TypeCompound> ctx)`
`void`	`appendUniqueTypeAttributes(List<Attribute.TypeCompound> l)`
`Symbol`	`asMemberOf(Type site, Types types)` The (variable or method) symbol seen as a member of given class type`site' (this might change the symbol's type).
`Type`	`asType()` Returns the type defined by this element.
`Attribute.Compound`	`attribute(Symbol anno)` Fetch a particular annotation from a symbol.
`Symbol`	`baseSymbol()`
`Symbol`	`clone(Symbol newOwner)` Clone this symbol with new owner.
`void`	`complete()` Complete the elaboration of this symbol's definition.
`Symbol.ClassSymbol`	`enclClass()` The closest enclosing class of this symbol's declaration.
`Type`	`erasure(Types types)` The symbol's erased type.
`boolean`	`exists()` True if the symbol represents an entity that exists.
`Type`	`externalType(Types types)` The external type of a symbol.
`long`	`flags()` An accessor method for the flags of this symbol.
`Name`	`flatName()` The fully qualified name of this symbol after converting to flat representation.
`List<Attribute.Compound>`	`getAnnotationMirrors()` This is the implementation for `javax.lang.model.element.Element.getAnnotationMirrors()`.
`List<Attribute.TypeCompound>`	`getClassInitTypeAttributes()`
`List<Attribute.Compound>`	`getDeclarationAttributes()`
`List<Symbol>`	`getEnclosedElements()` Returns the elements that are, loosely speaking, directly enclosed by this element.
`Symbol`	`getEnclosingElement()` Returns the innermost element within which this element is, loosely speaking, enclosed.
`List<Attribute.TypeCompound>`	`getInitTypeAttributes()`
`ElementKind`	`getKind()` Returns the `kind` of this element.
`SymbolMetadata`	`getMetadata()` This method is intended for debugging only.
`Set<Modifier>`	`getModifiers()` Returns the modifiers of this element, excluding annotations.
`Name`	`getQualifiedName()` The fully qualified name of this symbol.
`List<Attribute.Compound>`	`getRawAttributes()` An accessor method for the attributes of this symbol.
`List<Attribute.TypeCompound>`	`getRawTypeAttributes()` An accessor method for the type attributes of this symbol.
`Name`	`getSimpleName()` Returns the simple (unqualified) name of this element.
`List<Symbol.TypeVariableSymbol>`	`getTypeParameters()`
`boolean`	`hasAnnotations()`
`boolean`	`hasOuterInstance()` An inner class has an outer instance if it is not an interface it has an enclosing instance class which might be referenced from the class.
`boolean`	`hasTypeAnnotations()`
`boolean`	`isAnonymous()` Has this symbol an empty name? This includes anonymous inner classes.
`boolean`	`isConstructor()` Is this symbol a constructor?
`boolean`	`isDeprecated()`
`boolean`	`isEnclosedBy(Symbol.ClassSymbol clazz)` Is this symbol the same as or enclosed by the given class?
`boolean`	`isEnum()`
`boolean`	`isInheritedIn(Symbol clazz, Types types)` Is this symbol inherited into a given class? PRE: If symbol's owner is a interface, it is already assumed that the interface is a superinterface of given class.
`boolean`	`isInner()` A class is an inner class if it it has an enclosing instance class.
`boolean`	`isInterface()`
`boolean`	`isLocal()` Is this symbol declared (directly or indirectly) local to a method or variable initializer? Also includes fields of inner classes which are in turn local to a method or variable initializer.
`boolean`	`isMemberOf(Symbol.TypeSymbol clazz, Types types)` Fully check membership: hierarchy, protection, and hiding.
`boolean`	`isPrivate()`
`boolean`	`isStatic()`
`boolean`	`isSubClass(Symbol base, Types types)` Is this symbol a subclass of `base'? Only defined for ClassSymbols.
`Symbol`	`location()` A Java source description of the location of this symbol; used for error reporting.
`Symbol`	`location(Type site, Types types)`
`Scope`	`members()` If this is a class or package, its members, otherwise null.
`Symbol.ClassSymbol`	`outermostClass()` The outermost class which indirectly owns this symbol.
`boolean`	`overrides(Symbol _other, Symbol.TypeSymbol origin, Types types, boolean checkResult)` Does this method symbol override `other' symbol, when both are seen as members of class `origin'? It is assumed that _other is a member of origin.
`Symbol.PackageSymbol`	`packge()` The package which indirectly owns this symbol.
`void`	`prependAttributes(List<Attribute.Compound> l)`
`void`	`resetAnnotations()`
`void`	`setAttributes(Symbol other)`
`void`	`setDeclarationAttributes(List<Attribute.Compound> a)`
`void`	`setDeclarationAttributesWithCompletion(Annotate.AnnotateRepeatedContext<Attribute.Compound> ctx)`
`void`	`setTypeAttributes(List<Attribute.TypeCompound> a)`
`String`	`toString()` The Java source which this symbol represents.

Methods inherited from class com.sun.tools.javac.code.AnnoConstruct
getAnnotation, getAnnotationsByType, getAttribute, getInheritedAnnotations

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

Methods inherited from interface javax.lang.model.element.Element
accept, equals, getAnnotation, hashCode

Methods inherited from interface javax.lang.model.AnnotatedConstruct
getAnnotationsByType

- Field Detail
  - kind
```
public int kind
```
    The kind of this symbol.
    
    See Also:
    
    Kinds
  - flags_field
```
public long flags_field
```
    The flags of this symbol.
  - name
```
public Name name
```
    The name of this symbol in Utf8 representation.
  - type
```
public Type type
```
    The type of this symbol.
  - owner
```
public Symbol owner
```
    The owner of this symbol.
  - completer
```
public Symbol.Completer completer
```
    The completer of this symbol.
  - erasure_field
```
public Type erasure_field
```
    A cache for the type erasure of this symbol.
  - metadata
```
protected SymbolMetadata metadata
```
    The attributes of this symbol are contained in this SymbolMetadata. The SymbolMetadata instance is NOT immutable.
- Constructor Detail
  - Symbol
```
public Symbol(int kind,
              long flags,
              Name name,
              Type type,
              Symbol owner)
```
    Construct a symbol with given kind, flags, name, type and owner.
- Method Detail
  - flags
```
public long flags()
```
    An accessor method for the flags of this symbol. Flags of class symbols should be accessed through the accessor method to make sure that the class symbol is loaded.
  - getRawAttributes
```
public List<Attribute.Compound> getRawAttributes()
```
    An accessor method for the attributes of this symbol. Attributes of class symbols should be accessed through the accessor method to make sure that the class symbol is loaded.
  - getRawTypeAttributes
```
public List<Attribute.TypeCompound> getRawTypeAttributes()
```
    An accessor method for the type attributes of this symbol. Attributes of class symbols should be accessed through the accessor method to make sure that the class symbol is loaded.
  - attribute
```
public Attribute.Compound attribute(Symbol anno)
```
    Fetch a particular annotation from a symbol.
  - annotationsPendingCompletion
```
public boolean annotationsPendingCompletion()
```
  - appendAttributes
```
public void appendAttributes(List<Attribute.Compound> l)
```
  - appendClassInitTypeAttributes
```
public void appendClassInitTypeAttributes(List<Attribute.TypeCompound> l)
```
  - appendInitTypeAttributes
```
public void appendInitTypeAttributes(List<Attribute.TypeCompound> l)
```
  - appendTypeAttributesWithCompletion
```
public void appendTypeAttributesWithCompletion(Annotate.AnnotateRepeatedContext<Attribute.TypeCompound> ctx)
```
  - appendUniqueTypeAttributes
```
public void appendUniqueTypeAttributes(List<Attribute.TypeCompound> l)
```
  - getClassInitTypeAttributes
```
public List<Attribute.TypeCompound> getClassInitTypeAttributes()
```
  - getInitTypeAttributes
```
public List<Attribute.TypeCompound> getInitTypeAttributes()
```
  - getDeclarationAttributes
```
public List<Attribute.Compound> getDeclarationAttributes()
```
  - hasAnnotations
```
public boolean hasAnnotations()
```
  - hasTypeAnnotations
```
public boolean hasTypeAnnotations()
```
  - prependAttributes
```
public void prependAttributes(List<Attribute.Compound> l)
```
  - resetAnnotations
```
public void resetAnnotations()
```
  - setAttributes
```
public void setAttributes(Symbol other)
```
  - setDeclarationAttributes
```
public void setDeclarationAttributes(List<Attribute.Compound> a)
```
  - setDeclarationAttributesWithCompletion
```
public void setDeclarationAttributesWithCompletion(Annotate.AnnotateRepeatedContext<Attribute.Compound> ctx)
```
  - setTypeAttributes
```
public void setTypeAttributes(List<Attribute.TypeCompound> a)
```
  - getMetadata
```
public SymbolMetadata getMetadata()
```
    This method is intended for debugging only.
  - clone
```
public Symbol clone(Symbol newOwner)
```
    Clone this symbol with new owner. Legal only for fields and methods.
  - accept
```
public <R,P> R accept(Symbol.Visitor<R,P> v,
                      P p)
```
  - toString
```
public String toString()
```
    The Java source which this symbol represents. A description of this symbol; overrides Object.
    
    Overrides:
    
    toString in class Object
  - location
```
public Symbol location()
```
    A Java source description of the location of this symbol; used for error reporting.
    
    Returns:
    
    null if the symbol is a package or a toplevel class defined in the default package; otherwise, the owner symbol is returned
  - location
```
public Symbol location(Type site,
                       Types types)
```
  - baseSymbol
```
public Symbol baseSymbol()
```
  - erasure
```
public Type erasure(Types types)
```
    The symbol's erased type.
  - externalType
```
public Type externalType(Types types)
```
    The external type of a symbol. This is the symbol's erased type except for constructors of inner classes which get the enclosing instance class added as first argument.
  - isDeprecated
```
public boolean isDeprecated()
```
  - isStatic
```
public boolean isStatic()
```
  - isInterface
```
public boolean isInterface()
```
  - isPrivate
```
public boolean isPrivate()
```
  - isEnum
```
public boolean isEnum()
```
  - isLocal
```
public boolean isLocal()
```
    Is this symbol declared (directly or indirectly) local to a method or variable initializer? Also includes fields of inner classes which are in turn local to a method or variable initializer.
  - isAnonymous
```
public boolean isAnonymous()
```
    Has this symbol an empty name? This includes anonymous inner classes.
  - isConstructor
```
public boolean isConstructor()
```
    Is this symbol a constructor?
  - getQualifiedName
```
public Name getQualifiedName()
```
    The fully qualified name of this symbol. This is the same as the symbol's name except for class symbols, which are handled separately.
  - flatName
```
public Name flatName()
```
    The fully qualified name of this symbol after converting to flat representation. This is the same as the symbol's name except for class symbols, which are handled separately.
  - members
```
public Scope members()
```
    If this is a class or package, its members, otherwise null.
  - isInner
```
public boolean isInner()
```
    A class is an inner class if it it has an enclosing instance class.
  - hasOuterInstance
```
public boolean hasOuterInstance()
```
    An inner class has an outer instance if it is not an interface it has an enclosing instance class which might be referenced from the class. Nested classes can see instance members of their enclosing class. Their constructors carry an additional this$n parameter, inserted implicitly by the compiler.
    
    See Also:
    
    isInner()
  - enclClass
```
public Symbol.ClassSymbol enclClass()
```
    The closest enclosing class of this symbol's declaration.
  - outermostClass
```
public Symbol.ClassSymbol outermostClass()
```
    The outermost class which indirectly owns this symbol.
  - packge
```
public Symbol.PackageSymbol packge()
```
    The package which indirectly owns this symbol.
  - isSubClass
```
public boolean isSubClass(Symbol base,
                          Types types)
```
    Is this symbol a subclass of `base'? Only defined for ClassSymbols.
  - isMemberOf
```
public boolean isMemberOf(Symbol.TypeSymbol clazz,
                          Types types)
```
    Fully check membership: hierarchy, protection, and hiding. Does not exclude methods not inherited due to overriding.
  - isEnclosedBy
```
public boolean isEnclosedBy(Symbol.ClassSymbol clazz)
```
    Is this symbol the same as or enclosed by the given class?
  - isInheritedIn
```
public boolean isInheritedIn(Symbol clazz,
                             Types types)
```
    Is this symbol inherited into a given class? PRE: If symbol's owner is a interface, it is already assumed that the interface is a superinterface of given class.
    
    Parameters:
    
    clazz - The class for which we want to establish membership. This must be a subclass of the member's owner.
  - asMemberOf
```
public Symbol asMemberOf(Type site,
                         Types types)
```
    The (variable or method) symbol seen as a member of given class type`site' (this might change the symbol's type). This is used exclusively for producing diagnostics.
  - overrides
```
public boolean overrides(Symbol _other,
                         Symbol.TypeSymbol origin,
                         Types types,
                         boolean checkResult)
```
    Does this method symbol override `other' symbol, when both are seen as members of class `origin'? It is assumed that _other is a member of origin. It is assumed that both symbols have the same name. The static modifier is ignored for this test. See JLS 8.4.6.1 (without transitivity) and 8.4.6.4
  - complete
```
public void complete()
              throws Symbol.CompletionFailure
```
    Complete the elaboration of this symbol's definition.
    
    Throws:
    
    Symbol.CompletionFailure
  - exists
```
public boolean exists()
```
    True if the symbol represents an entity that exists.
  - asType
```
public Type asType()
```
    Description copied from interface: Element
    
    Returns the type defined by this element.
    A generic element defines a family of types, not just one. If this is a generic element, a prototypical type is returned. This is the element's invocation on the type variables corresponding to its own formal type parameters. For example, for the generic class element C<N extends Number>, the parameterized type C<N> is returned. The Types utility interface has more general methods for obtaining the full range of types defined by an element.
    
    Specified by:
    
    asType in interface Element
    
    Returns:
    
    the type defined by this element
    
    See Also:
    
    Types
  - getEnclosingElement
```
public Symbol getEnclosingElement()
```
    Description copied from interface: Element
    Returns the innermost element within which this element is, loosely speaking, enclosed.
    - If this element is one whose declaration is lexically enclosed immediately within the declaration of another element, that other element is returned.
    - If this is a top-level type, its package is returned.
    - If this is a package, null is returned.
    - If this is a type parameter, the generic element of the type parameter is returned.
    - If this is a method or constructor parameter, the executable element which declares the parameter is returned.
    Specified by:
    
    getEnclosingElement in interface Element
    
    Returns:
    
    the enclosing element, or null if there is none
    
    See Also:
    
    Elements.getPackageOf(javax.lang.model.element.Element)
  - getKind
```
public ElementKind getKind()
```
    Description copied from interface: Element
    
    Returns the kind of this element.
    
    Specified by:
    
    getKind in interface Element
    
    Returns:
    
    the kind of this element
  - getModifiers
```
public Set<Modifier> getModifiers()
```
    Description copied from interface: Element
    
    Returns the modifiers of this element, excluding annotations. Implicit modifiers, such as the public and static modifiers of interface members, are included.
    
    Specified by:
    
    getModifiers in interface Element
    
    Returns:
    
    the modifiers of this element, or an empty set if there are none
  - getSimpleName
```
public Name getSimpleName()
```
    Description copied from interface: Element
    
    Returns the simple (unqualified) name of this element. The name of a generic type does not include any reference to its formal type parameters. For example, the simple name of the type element java.util.Set<E> is "Set". If this element represents an unnamed package, an empty name is returned. If it represents a constructor, the name "<init>" is returned. If it represents a static initializer, the name "<clinit>" is returned. If it represents an anonymous class or instance initializer, an empty name is returned.
    
    Specified by:
    
    getSimpleName in interface Element
    
    Returns:
    
    the simple name of this element
    
    See Also:
    
    PackageElement.getSimpleName(), ExecutableElement.getSimpleName(), TypeElement.getSimpleName(), VariableElement.getSimpleName()
  - getAnnotationMirrors
```
public List<Attribute.Compound> getAnnotationMirrors()
```
    This is the implementation for javax.lang.model.element.Element.getAnnotationMirrors().
    
    Specified by:
    
    getAnnotationMirrors in interface AnnotatedConstruct
    
    Specified by:
    
    getAnnotationMirrors in interface Element
    
    Specified by:
    
    getAnnotationMirrors in class AnnoConstruct
    
    Returns:
    
    the annotations directly present on this construct; an empty list if there are none
  - getEnclosedElements
```
public List<Symbol> getEnclosedElements()
```
    Description copied from interface: Element
    
    Returns the elements that are, loosely speaking, directly enclosed by this element. A class or interface is considered to enclose the fields, methods, constructors, and member types that it directly declares. A package encloses the top-level classes and interfaces within it, but is not considered to enclose subpackages. Other kinds of elements are not currently considered to enclose any elements; however, that may change as this API or the programming language evolves.
    Note that elements of certain kinds can be isolated using methods in ElementFilter.
    
    Specified by:
    
    getEnclosedElements in interface Element
    
    Returns:
    
    the enclosed elements, or an empty list if none
    
    See Also:
    
    PackageElement.getEnclosedElements(), TypeElement.getEnclosedElements(), Elements.getAllMembers(javax.lang.model.element.TypeElement)
  - getTypeParameters
```
public List<Symbol.TypeVariableSymbol> getTypeParameters()
```

Class Symbol

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.sun.tools.javac.code.AnnoConstruct

Methods inherited from class java.lang.Object

Methods inherited from interface javax.lang.model.element.Element

Methods inherited from interface javax.lang.model.AnnotatedConstruct

Field Detail

kind

flags_field

name

type

owner

completer

erasure_field

metadata

Constructor Detail

Symbol

Method Detail

flags

getRawAttributes

getRawTypeAttributes

attribute

annotationsPendingCompletion

appendAttributes

appendClassInitTypeAttributes

appendInitTypeAttributes

appendTypeAttributesWithCompletion

appendUniqueTypeAttributes

getClassInitTypeAttributes

getInitTypeAttributes

getDeclarationAttributes

hasAnnotations

hasTypeAnnotations

prependAttributes

resetAnnotations

setAttributes

setDeclarationAttributes

setDeclarationAttributesWithCompletion

setTypeAttributes

getMetadata

clone

accept

toString

location

location

baseSymbol

erasure

externalType

isDeprecated

isStatic

isInterface

isPrivate

isEnum

isLocal

isAnonymous

isConstructor

getQualifiedName

flatName

members

isInner

hasOuterInstance

enclClass

outermostClass

packge

isSubClass

isMemberOf

isEnclosedBy

isInheritedIn

asMemberOf

overrides

complete

exists

asType

getEnclosingElement

getKind

getModifiers

getSimpleName