Package net.bytebuddy.description.type

Class TypeDescription.ForPackageDescription

java.lang.Object
net.bytebuddy.description.ModifierReviewable.AbstractBase
net.bytebuddy.description.TypeVariableSource.AbstractBase
net.bytebuddy.description.type.TypeDescription.AbstractBase
net.bytebuddy.description.type.TypeDescription.AbstractBase.OfSimpleType
net.bytebuddy.description.type.TypeDescription.ForPackageDescription
All Implemented Interfaces:
Iterable<TypeDefinition>, AnnotationSource, ByteCodeElement, DeclaredByType, ModifierReviewable, ModifierReviewable.ForFieldDescription, ModifierReviewable.ForMethodDescription, ModifierReviewable.ForParameterDescription, ModifierReviewable.ForTypeDefinition, ModifierReviewable.OfAbstraction, ModifierReviewable.OfByteCodeElement, ModifierReviewable.OfEnumeration, NamedElement, NamedElement.WithDescriptor, NamedElement.WithRuntimeName, TypeDefinition, TypeDescription, TypeVariableSource
Enclosing interface:
TypeDescription
public static class TypeDescription.ForPackageDescription extends TypeDescription.AbstractBase.OfSimpleType
A type representation of a package description.

  • Field Details

    • packageDescription

      private final PackageDescription packageDescription
      The package to be described as a type.

  • Constructor Details

    • ForPackageDescription

      public ForPackageDescription(PackageDescription packageDescription)
      Creates a new type description of a package description.
      Parameters:
      packageDescription - The package to be described as a type.

  • Method Details

    • getSuperClass

      @MaybeNull public TypeDescription.Generic getSuperClass()
      Returns the super class of this type. A super type is only defined for non-generic types (TypeDefinition.Sort.NON_GENERIC), parameterized types (TypeDefinition.Sort.PARAMETERIZED) or generic array types (TypeDefinition.Sort.GENERIC_ARRAY) types. Interface types and the Object class do not define a super class where null is returned. Array types define Object as their direct super class.
      Returns:
      The super class of this type or null if no super class exists for this type.

    • getInterfaces

      public TypeList.Generic getInterfaces()
      Returns the interfaces that this type implements. A super type is only defined for non-generic types (TypeDefinition.Sort.NON_GENERIC), parameterized types (TypeDefinition.Sort.PARAMETERIZED) or generic array types (TypeDefinition.Sort.GENERIC_ARRAY) types.
      Returns:
      The interfaces that this type implements.

    • getEnclosingMethod

      @MaybeNull public MethodDescription.InDefinedShape getEnclosingMethod()
      Returns a description of the method that encloses this type. If this method is not enclosed by any type or is enclosed by the type initializer, null is returned by this method.
      Returns:
      A description of the enclosing method of this type or null if there is no such method.

    • getEnclosingType

      @MaybeNull public TypeDescription getEnclosingType()
      Returns a description of this type's enclosing type if any.
      Returns:
      A description of the enclosing type of this type or null if there is no such type.

    • isAnonymousType

      public boolean isAnonymousType()
      Checks if this type description represents an anonymous type.
      Returns:
      true if this type description represents an anonymous type.

    • isLocalType

      public boolean isLocalType()
      Checks if this type description represents a local type.
      Returns:
      true if this type description represents a local type.

    • getDeclaredTypes

      public TypeList getDeclaredTypes()
      Returns a list of types that are declared by this type. This list does not normally include anonymous types but might include additional types if they are explicitly added to an instrumented type.
      Returns:
      A list of types that are declared within this type.

    • getDeclaredFields

      public FieldList<FieldDescription.InDefinedShape> getDeclaredFields()
      Returns the fields that this type declares. A super type is only defined for non-generic types (TypeDefinition.Sort.NON_GENERIC), parameterized types (TypeDefinition.Sort.PARAMETERIZED) or generic array types (TypeDefinition.Sort.GENERIC_ARRAY) types. Generic array types never define fields and the returned list is always empty for such types.
      Returns:
      The fields that this type declares. A super type is only defined for non-generic types (TypeDefinition.Sort.NON_GENERIC), parameterized types (TypeDefinition.Sort.PARAMETERIZED) or generic array types (TypeDefinition.Sort.GENERIC_ARRAY) types. Generic array types never define methods and the returned list is always empty for such types.

    • getDeclaredMethods

      public MethodList<MethodDescription.InDefinedShape> getDeclaredMethods()
      Returns the methods that this type declares.
      Returns:
      The methods that this type declares.

    • getPackage

      public PackageDescription getPackage()
      Returns the package of the type described by this instance or null if the described type is a primitive type or an array.
      Returns:
      The package of the type described by this instance or null if the described type is a primitive type or an array.

    • getDeclaredAnnotations

      public AnnotationList getDeclaredAnnotations()
      Returns a list of annotations that are declared by this instance.
      Returns:
      A list of declared annotations.

    • getDeclaringType

      @MaybeNull public TypeDescription getDeclaringType()
      Returns the declaring type of this instance.
      Returns:
      The declaring type or null if no such type exists.

    • getTypeVariables

      public TypeList.Generic getTypeVariables()
      Returns the type variables that are declared by this element.
      Returns:
      The type variables that are declared by this element.

    • getModifiers

      public int getModifiers()
      Returns the modifier that is described by this object.
      Returns:
      The modifier that is described by this object.

    • getName

      public String getName()
      Returns the binary name of this byte code element. If no well-defined internal name is known for this element, the actual name is returned.
      Returns:
      The binary ame of this byte code element as visible from within a running Java application.

    • getNestHost

      public TypeDescription getNestHost()
      Returns the nest host of this type. For types prior to Java 11, this type is returned which is the default nest host.
      Returns:
      The nest host of this type.

    • getNestMembers

      public TypeList getNestMembers()
      Returns a list of members that are part of a nesting group. Prior to Java 11, a list that only contains this type is returned which is the default nest group.
      Returns:
      A list of members of this nest group.

    • getRecordComponents

      public RecordComponentList<RecordComponentDescription.InDefinedShape> getRecordComponents()
      Returns the list of record components that are declared by this type. If this type is not a record, the returned list is empty.
      Returns:
      A list of record components that this type declares.

    • isRecord

      public boolean isRecord()
      Checks if this type is a Java record.
      Returns:
      true if this type is a Java record.

    • getPermittedSubtypes

      public TypeList getPermittedSubtypes()
      Returns the list of permitted direct subclasses if this class is a sealed class. Permitted subclasses might or might not be resolvable, where unresolvable subclasses might also be missing from the list. For returned types, methods that return the class's name will always be invokable without errors. If this type is not sealed, an empty list is returned. Note that an empty list might also be returned for a sealed type, if no type permitted subtype is resolvable.
      Returns:
      The list of permitted subtypes or an empty list if this type is not sealed.