- java.lang.Object
- 
- jdk.jfr.SettingDescriptor
 
- 
 public final class SettingDescriptor extends Object Describes an event setting.- Since:
- 9
 
- 
- 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description <A extends Annotation>
 AgetAnnotation(Class<A> annotationType)Returns the first annotation for the specified type if an annotation element with the same name is available,nullotherwise.List<AnnotationElement>getAnnotationElements()Returns an immutable list of annotation elements for this value descriptor.StringgetContentType()Returns a textual identifier that specifies how a value that is represented by thisSettingDescriptorobject is interpreted or formatted.StringgetDefaultValue()Returns the default value for this setting descriptor.StringgetDescription()Returns a sentence that describes the setting (for example"Record event with duration above or equal to threshold").StringgetLabel()Returns a human-readable name that describes the setting (for example,"Threshold").StringgetName()Returns the name of the setting (for example,"threshold").longgetTypeId()Returns a unique ID for the type in the Java Virtual Machine (JVM).StringgetTypeName()Returns the fully qualified class name of the type that is associated with this setting descriptor.
 
- 
- 
- 
Method Detail- 
getNamepublic String getName() Returns the name of the setting (for example,"threshold").- Returns:
- the name, not null
 
 - 
getLabelpublic String getLabel() Returns a human-readable name that describes the setting (for example,"Threshold").If the setting lacks a label, the label for the type that is associated with this setting is returned, or nullif doesn't exist- Returns:
- a human-readable name, or nullif doesn't exist
 
 - 
getDescriptionpublic String getDescription() Returns a sentence that describes the setting (for example"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 nullif doesn't exist.- Returns:
- the description, or nullif doesn't exist
 
 - 
getContentTypepublic String getContentType() Returns a textual identifier that specifies how a value that is represented by thisSettingDescriptorobject 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: - jdk.jfr.Percentage
- jdk.jfr.Timespan
- jdk.jfr.Timestamp
- jdk.jfr.Frequency
- jdk.jfr.Flag
- jdk.jfr.MemoryAddress
- jdk.jfr.DataAmount
- jdk.jfr.NetworkAddress
 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 nullif not available.- Returns:
- the content type, or nullif doesn't exist
- See Also:
- ContentType
 
 - 
getTypeNamepublic String getTypeName() Returns the fully qualified class name of the type that is associated with this setting descriptor.- Returns:
- the type name, not null
- See Also:
- getTypeId()
 
 - 
getTypeIdpublic long getTypeId() Returns a unique ID for the type in the Java Virtual Machine (JVM).The ID might not be the same between JVM instances. - Returns:
- the type ID, not negative
 
 - 
getAnnotationpublic <A extends Annotation> A getAnnotation(Class<A> annotationType) Returns the first annotation for the specified type if an annotation element with the same name is available,nullotherwise.- Type Parameters:
- A- the type of the annotation to query for and return if available
- Parameters:
- annotationType- the Class object that corresponds to the annotation type, not- null
- Returns:
- this element's annotation for the specified annotation type if
         available, nullotherwise
 
 - 
getAnnotationElementspublic List<AnnotationElement> getAnnotationElements() Returns an immutable list of annotation elements for this value descriptor.- Returns:
- a list of annotations, not null
 
 - 
getDefaultValuepublic String getDefaultValue() Returns the default value for this setting descriptor.- Returns:
- the default value, not null
 
 
- 
 
-