Package net.bytebuddy.description.type

Class TypeDescription.ArrayProjection

    • Field Detail

      • ARRAY_IMPLIED

        private static final int ARRAY_IMPLIED
        Modifiers that every array in Java implies.
        See Also:
        Constant Field Values

      • ARRAY_EXCLUDED

        private static final int ARRAY_EXCLUDED
        Modifiers that no array in Java displays.
        See Also:
        Constant Field Values

      • componentType

        private final TypeDescription componentType
        The base component type which is itself not an array.

      • arity

        private final int arity
        The arity of this array.

    • Constructor Detail

      • ArrayProjection

        protected ArrayProjection​(TypeDescription componentType,
                          int arity)
        Creates a new array projection.
        Parameters:
        componentType - The base component type of the array which is itself not an array.
        arity - The arity of this array.

    • Method Detail

      • of

        public static TypeDescription of​(TypeDescription componentType)
        Creates an array projection of an arity of one.
        Parameters:
        componentType - The component type of the array.
        Returns:
        A projection of the component type as an array of the given value with an arity of one.

      • of

        public static TypeDescription of​(TypeDescription componentType,
                                 int arity)
        Creates an array projection.
        Parameters:
        componentType - The component type of the array.
        arity - The arity of this array.
        Returns:
        A projection of the component type as an array of the given value with the supplied arity.

      • isArray

        public boolean isArray()
        Checks if the type described by this entity is an array.
        Returns:
        true if this type description represents an array.

      • isPrimitive

        public boolean isPrimitive()
        Checks if the type described by this entity is a primitive type.
        Returns:
        true if this type description represents a primitive type.

      • 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.

      • 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.

      • getSimpleName

        public java.lang.String getSimpleName()
        Returns the simple name of this type.
        Returns:
        The simple name of this type.

      • getCanonicalName

        @MaybeNull
public java.lang.String getCanonicalName()
        Returns the canonical name of this type if it exists.
        Returns:
        The canonical name of this type. Might be null.

      • 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.

      • getStackSize

        public StackSize getStackSize()
        Returns the size of the type described by this instance. Wildcard types (TypeDefinition.Sort.WILDCARD do not have a well-defined a stack size and cause an IllegalStateException to be thrown.
        Returns:
        The size of the type described by this instance.

      • getDeclaredAnnotations

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

      • getPackage

        @MaybeNull
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.

      • toModuleDescription

        @MaybeNull
public ModuleDescription toModuleDescription()
        Returns a representation of a Java module that is represented by this type description, normally a module-info.class file. If there is no module meta-data attached to the current class, null is returned.
        Returns:
        A description of the module information of this type or null if no such information is available.

      • getName

        public java.lang.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.

      • getDescriptor

        public java.lang.String getDescriptor()
        Returns the descriptor of this byte code element.
        Returns:
        The descriptor of this byte code element.

      • getDeclaringType

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

      • getModifiers

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

      • 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.

      • 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.