Class CustomAttribute<T extends CustomAttribute<T>>
java.lang.Object
java.lang.classfile.CustomAttribute<T>
- Type Parameters:
T- the custom attribute type
- All Implemented Interfaces:
Attribute<T>, ClassElement, ClassFileElement, CodeElement, FieldElement, MethodElement
public abstract non-sealed class CustomAttribute<T extends CustomAttribute<T>>
extends Object
implements Attribute<T>, CodeElement, ClassElement, MethodElement, FieldElement
Models a user-defined attribute in a
class file. API models for
user-defined attributes should extend this class. A user-defined attribute
should also have an AttributeMapper defined, which will be returned
by attributeMapper(), and registered to the ClassFile.AttributeMapperOption so the user-defined attributes can be read.
Accessor methods on user-defined attributes read from class files
may throw IllegalArgumentException if the attribute model is lazily
evaluated, and the evaluation encounters malformed class file format
for the attribute.
- Since:
- 24
- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCustomAttribute(AttributeMapper<T> mapper) Constructor for subclasses to call. -
Method Summary
Modifier and TypeMethodDescriptionfinal AttributeMapper<T> Returns theAttributeMapperassociated with this attribute.Returns the name of the attribute.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitModifier and TypeMethodDescriptionprotected Objectclone()Creates and returns a copy of this object.booleanIndicates whether some other object is "equal to" this one.protected voidfinalize()Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class<?> getClass()Returns the runtime class of thisObject.inthashCode()Returns a hash code value for this object.final voidnotify()Wakes up a single thread that is waiting on this object's monitor.final voidWakes up all threads that are waiting on this object's monitor.toString()Returns a string representation of the object.final voidwait()Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final voidwait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final voidwait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Constructor Details
-
CustomAttribute
Constructor for subclasses to call.- Parameters:
mapper- the attribute mapper
-
-
Method Details
-
attributeMapper
Description copied from interface:AttributeReturns theAttributeMapperassociated with this attribute.- Specified by:
attributeMapperin interfaceAttribute<T extends CustomAttribute<T>>- Returns:
- the
AttributeMapperassociated with this attribute
-
attributeName
Returns the name of the attribute. The string value of the name is equivalent to the value ofattributeMapper().name().If this attribute is read from a
classfile, this method returns theUtf8Entryindicating the attribute name in theclassfile.- Specified by:
attributeNamein interfaceAttribute<T extends CustomAttribute<T>>- Implementation Requirements:
- The default implementation returns a
Utf8Entrysuitable for writing only, which may be unbound. Subclasses representing attributes read fromclassfiles must override this method. - Returns:
- the name of the attribute
- See Also:
-