public final class SettingDescriptor extends Object
Modifier and Type | Method | Description |
---|---|---|
<A extends Annotation> |
getAnnotation |
Returns the first annotation for the specified type if an annotation element with the same name is available, null otherwise. |
List |
getAnnotationElements() |
Returns an immutable list of annotation elements for this value descriptor. |
String |
getContentType() |
Returns a textual identifier that specifies how a value that is represented by this SettingDescriptor object is interpreted or formatted. |
String |
getDefaultValue() |
Returns the default value for this setting descriptor. |
String |
getDescription() |
Returns a sentence that describes the setting (for example "Record event with duration
above or equal to threshold" ). |
String |
getLabel() |
Returns a human-readable name that describes the setting (for example, "Threshold" ). |
String |
getName() |
Returns the name of the setting (for example, "threshold" ). |
long |
getTypeId() |
Returns a unique ID for the type in the Java Virtual Machine (JVM). |
String |
getTypeName() |
Returns the fully qualified class name of the type that is associated with this setting descriptor. |
public String getName()
"threshold"
).null
public String getLabel()
"Threshold"
). If the setting lacks a label, the label for the type that is associated with this setting is returned, or null
if doesn't exist
null
if doesn't existpublic String getDescription()
"Record event with duration
above or equal to threshold"
). If the setting lacks a description, the description for the type that is associated with this setting is returned, or null
if doesn't exist.
null
if doesn't existpublic String getContentType()
SettingDescriptor
object is interpreted or formatted. For example, if the setting descriptor represents a percentage, then "jdk.jfr.Percentage"
hints to a client that a value of "0.5" is formatted as "50%".
The JDK provides the following predefined content types:
User-defined content types can be created by using ContentType
.
If the setting lacks a content type, the content type for the type that is associated with this setting is returned, or null
if not available.
null
if doesn't existpublic String getTypeName()
null
public long getTypeId()
The ID might not be the same between JVM instances.
public <A extends Annotation> A getAnnotation(Class<A> annotationType)
null
otherwise.A
- the type of the annotation to query for and return if availableannotationType
- the Class object that corresponds to the annotation type, not null
null
otherwisepublic List<AnnotationElement> getAnnotationElements()
null
public String getDefaultValue()
null
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.jfr/jdk/jfr/SettingDescriptor.html