TypeDeclaration (java-symbol-solver-model 0.3.2 API)

All Superinterfaces:

Declaration, TypeParametrizable

All Known Subinterfaces:

ClassDeclaration, EnumDeclaration, InterfaceDeclaration
```
public interface TypeDeclaration
extends Declaration, TypeParametrizable
```
A declaration of a type. It could be a primitive type, an enum, a class, an interface or a type variable. It cannot be an annotation or an array.

Author:

Federico Tomassetti

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default ClassDeclaration`	`asClass()` Return this as a ClassDeclaration or throw UnsupportedOperationException.
`default EnumDeclaration`	`asEnum()` Return this as a EnumDeclaration or throw UnsupportedOperationException.
`default InterfaceDeclaration`	`asInterface()` Return this as a InterfaceDeclaration or throw UnsupportedOperationException.
`default TypeDeclaration`	`asType()` Return this as a TypeDeclaration or throw an UnsupportedOperationException
`default TypeParameterDeclaration`	`asTypeParameter()` Return this as a TypeParameterDeclaration or throw UnsupportedOperationException.
`default boolean`	`canBeAssignedTo(TypeDeclaration other)` Can we assign instances of the type defined by this declaration to variables having the type defined by the given type?
`default Optional<TypeDeclaration>`	`containerType()` Get the TypeDeclaration enclosing this declaration.
`default Optional<TypeParameterDeclaration>`	`findTypeParameter(String name)` Find the closest TypeParameterDeclaration with the given name.
`default List<ReferenceType>`	`getAllAncestors()` The list of all the ancestors of the current declaration, direct and indirect.
`List<FieldDeclaration>`	`getAllFields()` Return a list of all fields, either declared in this declaration or inherited.
`Set<MethodUsage>`	`getAllMethods()` Return a list of all the methods declared of this type declaration, either declared or inherited.
`default List<FieldDeclaration>`	`getAllNonStaticFields()` Return a list of all the non static fields, either declared or inherited.
`default List<FieldDeclaration>`	`getAllStaticFields()` Return a list of all the static fields, either declared or inherited.
`List<ReferenceType>`	`getAncestors()` The list of all the direct ancestors of the current declaration.
`default List<FieldDeclaration>`	`getDeclaredFields()` Return a list of all the fields declared in this type.
`Set<MethodDeclaration>`	`getDeclaredMethods()` Return a list of all the methods declared in this type declaration.
`FieldDeclaration`	`getField(String name)` Note that the type of the field should be expressed using the type variables of this particular type.
`default String`	`getId()` The ID corresponds most of the type to the qualified name.
`String`	`getQualifiedName()` The fully qualified name of the type declared.
`default boolean`	`hasAnnotation(String qualifiedName)` Has the type at least one annotation declared or inherited having the specified qualified name?
`boolean`	`hasDirectlyAnnotation(String qualifiedName)` Has the type at least one annotation declared having the specified qualified name?
`boolean`	`hasField(String name)` Has this type a field with the given name?
`default Set<TypeDeclaration>`	`internalTypes()` Get the list of types defined inside the current type.
`boolean`	`isAssignableBy(Type type)` Can we assign instances of the given type to variables having the type defined by this declaration?
`boolean`	`isAssignableBy(TypeDeclaration other)` Can we assign instances of the given type to variables having the type defined by this declaration?
`default boolean`	`isClass()` Is this the declaration of a class? Note that an Enum is not considered a Class in this case.
`default boolean`	`isEnum()` Is this the declaration of an enum?
`default boolean`	`isInterface()` Is this the declaration of an interface?
`default boolean`	`isType()` Does this declaration represents a type?
`default boolean`	`isTypeParameter()` Is this the declaration of a type parameter?

Methods inherited from interface com.github.javaparser.symbolsolver.model.declarations.Declaration
asField, asMethod, asParameter, getName, hasName, isField, isMethod, isParameter

Methods inherited from interface com.github.javaparser.symbolsolver.model.declarations.TypeParametrizable
getTypeParameters

- Method Detail
  - internalTypes
```
default Set<TypeDeclaration> internalTypes()
```
    Get the list of types defined inside the current type.
  - containerType
```
default Optional<TypeDeclaration> containerType()
```
    Get the TypeDeclaration enclosing this declaration.
    
    Returns:
  - isClass
```
default boolean isClass()
```
    Is this the declaration of a class? Note that an Enum is not considered a Class in this case.
  - isInterface
```
default boolean isInterface()
```
    Is this the declaration of an interface?
  - isEnum
```
default boolean isEnum()
```
    Is this the declaration of an enum?
  - isTypeParameter
```
default boolean isTypeParameter()
```
    Is this the declaration of a type parameter?
  - isType
```
default boolean isType()
```
    Description copied from interface: Declaration
    
    Does this declaration represents a type?
    
    Specified by:
    
    isType in interface Declaration
  - asType
```
default TypeDeclaration asType()
```
    Description copied from interface: Declaration
    
    Return this as a TypeDeclaration or throw an UnsupportedOperationException
    
    Specified by:
    
    asType in interface Declaration
  - asClass
```
default ClassDeclaration asClass()
```
    Return this as a ClassDeclaration or throw UnsupportedOperationException.
  - asInterface
```
default InterfaceDeclaration asInterface()
```
    Return this as a InterfaceDeclaration or throw UnsupportedOperationException.
  - asEnum
```
default EnumDeclaration asEnum()
```
    Return this as a EnumDeclaration or throw UnsupportedOperationException.
  - asTypeParameter
```
default TypeParameterDeclaration asTypeParameter()
```
    Return this as a TypeParameterDeclaration or throw UnsupportedOperationException.
  - getQualifiedName
```
String getQualifiedName()
```
    The fully qualified name of the type declared.
  - getId
```
default String getId()
```
    The ID corresponds most of the type to the qualified name. It differs only for local classes which do not have a qualified name but have an ID.
  - findTypeParameter
```
default Optional<TypeParameterDeclaration> findTypeParameter(String name)
```
    Description copied from interface: TypeParametrizable
    
    Find the closest TypeParameterDeclaration with the given name. It first look on this element itself and then on the containers.
    
    Specified by:
    
    findTypeParameter in interface TypeParametrizable
  - getAncestors
```
List<ReferenceType> getAncestors()
```
    The list of all the direct ancestors of the current declaration. Note that the ancestor can be parametrized types with values specified. For example:
    class A implements Comparable<String> {}
    In this case the ancestor is Comparable<String>
  - getAllAncestors
```
default List<ReferenceType> getAllAncestors()
```
    The list of all the ancestors of the current declaration, direct and indirect. This list does not contains duplicates with the exacting same type parameters.
  - getField
```
FieldDeclaration getField(String name)
```
    Note that the type of the field should be expressed using the type variables of this particular type. Consider for example:
    class Foo { E field; }
    class Bar extends Foo { }
    When calling getField("field") on Foo I should get a FieldDeclaration with type E, while calling it on Bar I should get a FieldDeclaration with type String.
  - hasField
```
boolean hasField(String name)
```
    Has this type a field with the given name?
  - getAllFields
```
List<FieldDeclaration> getAllFields()
```
    Return a list of all fields, either declared in this declaration or inherited.
  - getAllNonStaticFields
```
default List<FieldDeclaration> getAllNonStaticFields()
```
    Return a list of all the non static fields, either declared or inherited.
  - getAllStaticFields
```
default List<FieldDeclaration> getAllStaticFields()
```
    Return a list of all the static fields, either declared or inherited.
  - getDeclaredFields
```
default List<FieldDeclaration> getDeclaredFields()
```
    Return a list of all the fields declared in this type.
  - getDeclaredMethods
```
Set<MethodDeclaration> getDeclaredMethods()
```
    Return a list of all the methods declared in this type declaration.
  - getAllMethods
```
Set<MethodUsage> getAllMethods()
```
    Return a list of all the methods declared of this type declaration, either declared or inherited. Note that it should not include overridden methods.
  - isAssignableBy
```
boolean isAssignableBy(Type type)
```
    Can we assign instances of the given type to variables having the type defined by this declaration?
  - canBeAssignedTo
```
default boolean canBeAssignedTo(TypeDeclaration other)
```
    Can we assign instances of the type defined by this declaration to variables having the type defined by the given type?
  - isAssignableBy
```
boolean isAssignableBy(TypeDeclaration other)
```
    Can we assign instances of the given type to variables having the type defined by this declaration?
  - hasDirectlyAnnotation
```
boolean hasDirectlyAnnotation(String qualifiedName)
```
    Has the type at least one annotation declared having the specified qualified name?
  - hasAnnotation
```
default boolean hasAnnotation(String qualifiedName)
```
    Has the type at least one annotation declared or inherited having the specified qualified name?

Interface TypeDeclaration

Method Summary

Methods inherited from interface com.github.javaparser.symbolsolver.model.declarations.Declaration

Methods inherited from interface com.github.javaparser.symbolsolver.model.declarations.TypeParametrizable

Method Detail

internalTypes

containerType

isClass

isInterface

isEnum

isTypeParameter

isType

asType

asClass

asInterface

asEnum

asTypeParameter

getQualifiedName

getId

findTypeParameter

getAncestors

getAllAncestors

getField

hasField

getAllFields

getAllNonStaticFields

getAllStaticFields

getDeclaredFields

getDeclaredMethods

getAllMethods

isAssignableBy

canBeAssignedTo

isAssignableBy

hasDirectlyAnnotation

hasAnnotation