Jakarta EE 11.0.0 · jakarta.enterprise.lang.model.declarations.ClassInfo

Method Summary

Modifier and Type	Method and Description
public default ClassInfo	asClass() Overrides default jakarta.enterprise.lang.model.declarations.DeclarationInfo.asClass. Returns this declaration as a class.
public Collection<MethodInfo>	Returns: immutable collection of constructors, never `null` constructors() Returns a collection of constructors declared or implicitly declared in this class.
public Collection<FieldInfo>	Returns: immutable collection of fields, never `null` fields() Returns a collection of fields declared or implicitly declared in this class and all its superclasses up to and excluding `java.lang.Object`, as well as all direct and indirect superinterfaces.
public boolean	Returns: whether this class is `abstract` isAbstract() Returns whether this class is abstract.
public boolean	Returns: whether this class is an annotation isAnnotation() Returns whether this class is an annotation.
public boolean	Returns: whether this class is an enum isEnum() Returns whether this class is an enum.
public boolean	Returns: whether this class is `final` isFinal() Returns whether this class is `final`.
public boolean	Returns: whether this class is an interface isInterface() Returns whether this class is an interface.
public boolean	Returns: whether this class is a plain class isPlainClass() Returns whether this class is a plain class.
public boolean	Returns: whether this class is a record isRecord() Returns whether this class is a record.
public default DeclarationInfo.Kind	kind() Implements jakarta.enterprise.lang.model.declarations.DeclarationInfo.kind. Returns the kind of this declaration.
public Collection<MethodInfo>	Returns: immutable collection of methods, never `null` methods() Returns a collection of methods declared or implicitly declared in this class and all its superclasses up to and excluding `java.lang.Object`, as well as all direct and indirect superinterfaces.
public int	Returns: the modifiers of this class modifiers() Returns the modifiers of this class as an `int`.
public String	Returns: binary name of this class, never `null` name() Returns the binary name of this class, as defined by The Java™ Language Specification; in other words, the class name as returned by `Class#getName()`.
public PackageInfo	Returns: this class's package, or `null` if this class is in an unnamed package packageInfo() Returns the package this class is part of.
public Collection<RecordComponentInfo>	Returns: immutable collection of record components, never `nul` recordComponents() Returns a collection of record components declared in this class.
public String	Returns: simple name of this class, never `null` simpleName() Returns the simple name of this class, as defined by The Java™ Language Specification; in other words, the class name as returned by `Class#getSimpleName()`.
public Type	Returns: the direct superclass type of this class, or `null` if there's no superclass superClass() Returns the direct superclass type of this class.
public ClassInfo	Returns: the direct superclass of this class, or `null` if there's no superclass superClassDeclaration() Returns the direct superclass of this class.
public List<Type>	Returns: immutable list of direct superinterface types of this class, never `null` superInterfaces() Returns a list of direct superinterface types of this class.
public List<ClassInfo>	Returns: immutable list of direct superinterfaces of this class, never `null` superInterfacesDeclarations() Returns a list of direct superinterfaces of this class.
public List<TypeVariable>	Returns: immutable list of this class's type parameters, never `null` typeParameters() Returns a list of type parameters declared on this class.

Inherited from jakarta.enterprise.lang.model.declarations.DeclarationInfo:: asDeclaration asField asMethod asPackage asParameter asRecordComponent asType isClass isDeclaration isField isMethod isPackage isParameter isRecordComponent isType

Method Detail

asClass back to summary

asClass	back to summary
public default ClassInfo asClass() Overrides default jakarta.enterprise.lang.model.declarations.DeclarationInfo.asClass. Doc from jakarta.enterprise.lang.model.declarations.DeclarationInfo.asClass. Returns this declaration as a class. Returns:ClassInfo this class, never `null` Annotations @Override

public default ClassInfo asClass()

Overrides default jakarta.enterprise.lang.model.declarations.DeclarationInfo.asClass.

Doc from jakarta.enterprise.lang.model.declarations.DeclarationInfo.asClass.

Returns this declaration as a class.

Returns:ClassInfo

this class, never null

Annotations

@Override

constructors back to summary

constructors	back to summary
public Collection<MethodInfo> constructors() Returns a collection of constructors declared or implicitly declared in this class. Constructors declared in direct or indirect superclasses are not included. If this class is an interface or an annotation, returns an empty collection. Returns:Collection<MethodInfo> immutable collection of constructors, never `null`

public Collection<MethodInfo> constructors()

Returns a collection of constructors declared or implicitly declared in this class. Constructors declared in direct or indirect superclasses are not included.

If this class is an interface or an annotation, returns an empty collection.

Returns:Collection<MethodInfo>: immutable collection of constructors, never null

fields back to summary

fields	back to summary
public Collection<FieldInfo> fields() Returns a collection of fields declared or implicitly declared in this class and all its superclasses up to and excluding `java.lang.Object`, as well as all direct and indirect superinterfaces. If this class is `java.lang.Object`, its fields are not excluded. If this class is an interface, only superinterfaces are considered. If the collection of fields described above contains multiple fields with the same name, all such fields are returned. `FieldInfo.declaringClass` should be used to distinguish such fields Iteration order of the resulting collection is not defined and does not have to correspond to the inheritance hierarchy of this class. Returns:Collection<FieldInfo> immutable collection of fields, never `null`

public Collection<FieldInfo> fields()

Returns a collection of fields declared or implicitly declared in this class and all its superclasses up to and excluding java.lang.Object, as well as all direct and indirect superinterfaces. If this class is java.lang.Object, its fields are not excluded. If this class is an interface, only superinterfaces are considered.

If the collection of fields described above contains multiple fields with the same name, all such fields are returned. FieldInfo.declaringClass should be used to distinguish such fields

Iteration order of the resulting collection is not defined and does not have to correspond to the inheritance hierarchy of this class.

Returns:Collection<FieldInfo>: immutable collection of fields, never null

isAbstract back to summary

isAbstract	back to summary
public boolean isAbstract() Returns whether this class is abstract. A plain class is abstract if declared `abstract`. An enum is abstract if it declares `abstract` methods. An interface or an annotation is always abstract. A record is never abstract. Returns:boolean whether this class is `abstract`

public boolean isAbstract()

Returns whether this class is abstract.

A plain class is abstract if declared abstract. An enum is abstract if it declares abstract methods. An interface or an annotation is always abstract. A record is never abstract.

Returns:boolean: whether this class is abstract

isAnnotation	back to summary
public boolean isAnnotation() Returns whether this class is an annotation. Returns:boolean whether this class is an annotation

isAnnotation

back to summary

public boolean isAnnotation()

Returns whether this class is an annotation.

Returns:boolean: whether this class is an annotation

isEnum	back to summary
public boolean isEnum() Returns whether this class is an enum. Returns:boolean whether this class is an enum

isEnum

back to summary

public boolean isEnum()

Returns whether this class is an enum.

Returns:boolean: whether this class is an enum

isFinal back to summary

isFinal	back to summary
public boolean isFinal() Returns whether this class is `final`. Returns:boolean whether this class is `final`

public boolean isFinal()

Returns whether this class is final.

Returns:boolean: whether this class is final

isInterface back to summary

isInterface	back to summary
public boolean isInterface() Returns whether this class is an interface. If this class is an annotation, returns `false`. Returns:boolean whether this class is an interface

public boolean isInterface()

Returns whether this class is an interface. If this class is an annotation, returns false.

Returns:boolean: whether this class is an interface

isPlainClass	back to summary
public boolean isPlainClass() Returns whether this class is a plain class. That is, not an interface, not an enum, not an annotation, and not a record. Returns:boolean whether this class is a plain class

isPlainClass

back to summary

public boolean isPlainClass()

Returns whether this class is a plain class. That is, not an interface, not an enum, not an annotation, and not a record.

Returns:boolean: whether this class is a plain class

isRecord	back to summary
public boolean isRecord() Returns whether this class is a record. Returns:boolean whether this class is a record

isRecord

back to summary

public boolean isRecord()

Returns whether this class is a record.

Returns:boolean: whether this class is a record

kind	back to summary
public default DeclarationInfo.Kind kind() Implements jakarta.enterprise.lang.model.declarations.DeclarationInfo.kind. Doc from jakarta.enterprise.lang.model.declarations.DeclarationInfo.kind. Returns the kind of this declaration. Returns:DeclarationInfo.Kind the kind of this declaration Annotations @Override

kind

back to summary

public default DeclarationInfo.Kind kind()

Implements jakarta.enterprise.lang.model.declarations.DeclarationInfo.kind.

Doc from jakarta.enterprise.lang.model.declarations.DeclarationInfo.kind.

Returns the kind of this declaration.

Returns:DeclarationInfo.Kind

the kind of this declaration

Annotations

@Override

methods back to summary

methods	back to summary
public Collection<MethodInfo> methods() Returns a collection of methods declared or implicitly declared in this class and all its superclasses up to and excluding `java.lang.Object`, as well as all direct and indirect superinterfaces. If this class is `java.lang.Object`, its methods are not excluded. If this class is an interface, only superinterfaces are considered. Implicitly declared methods corresponding to `java.lang.Object` methods in interfaces are omitted. If the collection of methods described above contains multiple methods with the same signature, all such methods are returned. `MethodInfo.declaringClass` should be used to distinguish such methods. Iteration order of the resulting collection is not defined and does not have to correspond to the inheritance hierarchy of this class. Returns:Collection<MethodInfo> immutable collection of methods, never `null`

public Collection<MethodInfo> methods()

Returns a collection of methods declared or implicitly declared in this class and all its superclasses up to and excluding java.lang.Object, as well as all direct and indirect superinterfaces. If this class is java.lang.Object, its methods are not excluded. If this class is an interface, only superinterfaces are considered. Implicitly declared methods corresponding to java.lang.Object methods in interfaces are omitted.

If the collection of methods described above contains multiple methods with the same signature, all such methods are returned. MethodInfo.declaringClass should be used to distinguish such methods.

Iteration order of the resulting collection is not defined and does not have to correspond to the inheritance hierarchy of this class.

Returns:Collection<MethodInfo>: immutable collection of methods, never null

modifiers back to summary

modifiers	back to summary
public int modifiers() Returns the modifiers of this class as an `int`. Use `Modifier` to inspect the value. Returns:int the modifiers of this class

public int modifiers()

Returns the modifiers of this class as an int. Use Modifier to inspect the value.

Returns:int: the modifiers of this class

name back to summary

name	back to summary
public String name() Returns the binary name of this class, as defined by The Java™ Language Specification; in other words, the class name as returned by `Class#getName()`. Returns:String binary name of this class, never `null`

public String name()

Returns the binary name of this class, as defined by The Java™ Language Specification; in other words, the class name as returned by Class#getName().

Returns:String: binary name of this class, never null

packageInfo back to summary

packageInfo	back to summary
public PackageInfo packageInfo() Returns the package this class is part of. Returns `null` if this class is part of an unnamed package. Returns:PackageInfo this class's package, or `null` if this class is in an unnamed package

public PackageInfo packageInfo()

Returns the package this class is part of. Returns null if this class is part of an unnamed package.

Returns:PackageInfo: this class's package, or null if this class is in an unnamed package

recordComponents back to summary

recordComponents	back to summary
public Collection<RecordComponentInfo> recordComponents() Returns a collection of record components declared in this class. If this class is not a record, returns an empty collection. Returns:Collection<RecordComponentInfo> immutable collection of record components, never `nul`

public Collection<RecordComponentInfo> recordComponents()

Returns a collection of record components declared in this class. If this class is not a record, returns an empty collection.

Returns:Collection<RecordComponentInfo>: immutable collection of record components, never nul

simpleName back to summary

simpleName	back to summary
public String simpleName() Returns the simple name of this class, as defined by The Java™ Language Specification; in other words, the class name as returned by `Class#getSimpleName()`. Returns:String simple name of this class, never `null`

public String simpleName()

Returns the simple name of this class, as defined by The Java™ Language Specification; in other words, the class name as returned by Class#getSimpleName().

Returns:String: simple name of this class, never null

superClass back to summary

superClass	back to summary
public Type superClass() Returns the direct superclass type of this class. Returns `null` if this class does not have a superclass; that is, if this class is `java.lang.Object` or an interface. Returns:Type the direct superclass type of this class, or `null` if there's no superclass

public Type superClass()

Returns the direct superclass type of this class. Returns null if this class does not have a superclass; that is, if this class is java.lang.Object or an interface.

Returns:Type: the direct superclass type of this class, or null if there's no superclass

superClassDeclaration back to summary

superClassDeclaration	back to summary
public ClassInfo superClassDeclaration() Returns the direct superclass of this class. Returns `null` if this class does not have a superclass; that is, if this class is `java.lang.Object` or an interface. Returns:ClassInfo the direct superclass of this class, or `null` if there's no superclass

public ClassInfo superClassDeclaration()

Returns the direct superclass of this class. Returns null if this class does not have a superclass; that is, if this class is java.lang.Object or an interface.

Returns:ClassInfo: the direct superclass of this class, or null if there's no superclass

superInterfaces back to summary

superInterfaces	back to summary
public List<Type> superInterfaces() Returns a list of direct superinterface types of this class. Returns an empty list if this class has no direct superinterface. Returns:List<Type> immutable list of direct superinterface types of this class, never `null`

public List<Type> superInterfaces()

Returns a list of direct superinterface types of this class. Returns an empty list if this class has no direct superinterface.

Returns:List<Type>: immutable list of direct superinterface types of this class, never null

superInterfacesDeclarations back to summary

superInterfacesDeclarations	back to summary
public List<ClassInfo> superInterfacesDeclarations() Returns a list of direct superinterfaces of this class. Returns an empty list if this class has no direct superinterface. Returns:List<ClassInfo> immutable list of direct superinterfaces of this class, never `null`

public List<ClassInfo> superInterfacesDeclarations()

Returns a list of direct superinterfaces of this class. Returns an empty list if this class has no direct superinterface.

Returns:List<ClassInfo>: immutable list of direct superinterfaces of this class, never null

typeParameters back to summary

typeParameters	back to summary
public List<TypeVariable> typeParameters() Returns a list of type parameters declared on this class. Returns an empty list if this class is not generic and so does not declare type parameters. Returns:List<TypeVariable> immutable list of this class's type parameters, never `null`

public List<TypeVariable> typeParameters()

Returns a list of type parameters declared on this class. Returns an empty list if this class is not generic and so does not declare type parameters.

Returns:List<TypeVariable>: immutable list of this class's type parameters, never null

public Interface ClassInfo

Method Summary

Method Detail