OpenJDK 27 · jdk.jfr.internal.Type · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private final AnnotationConstruct	annos
pack-priv static final Type	BOOLEAN
pack-priv static final Type	BYTE
pack-priv static final Type	CHAR
pack-priv static final Type	CLASS
pack-priv static final Type	DOUBLE
public static final String	EVENT_NAME_PREFIX
private List<ValueDescriptor>	fields
pack-priv static final Type	FLOAT
private long	id
pack-priv static final Type	INT
private boolean	internal
private static final Map<Type, Class<?>>	knownTypes
pack-priv static final Type	LONG
private final String	name
private boolean	remove
public static final String	SETTINGS_PREFIX
pack-priv static final Type	SHORT
private Boolean	simpleType
public static final Type	STACK_TRACE
pack-priv static final Type	STRING
public static final String	SUPER_TYPE_ANNOTATION
public static final String	SUPER_TYPE_EVENT
public static final String	SUPER_TYPE_SETTING
private final String	superType
pack-priv static final Type	THREAD
public static final String	TYPES_PREFIX
private boolean	visible

Constructor Summary

Access	Constructor and Description
public	Type(String i.e "java.lang.String" javaTypeName, String i.e "java.lang.Annotation" superType, long the class id that represents the class in the JVM typeId) Creates a type
pack-priv	Type(String javaTypeName, String superType, long typeId, Boolean simpleType)

Method Summary

Modifier and Type	Method and Description
public void	add(ValueDescriptor valueDescriptor)
private boolean	calculateSimpleType()
public int	compareTo(Type that) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
private static Type	createKnownType(Class<?> clazz)
private static Type	createKnownType(String name, Class<?> clazz)
public boolean	equals(Object object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public <T> T	getAnnotation(Class<? extends Annotation> clazz)
public List<AnnotationElement>	getAnnotationElements()
public <T> T	getAnnotationValue(Class<? extends Annotation> clazz, T defaultValue)
public String	getDescription()
public ValueDescriptor	getField(String name)
public List<ValueDescriptor>	getFields()
public long	getId()
public static Type	getKnownType(String typeName)
public static Type	getKnownType(Class<?> clazz)
pack-priv static Collection<Type>	getKnownTypes()
public String	getLabel()
public String	getLogName()
public String	getName()
public boolean	getRemove()
public String	getSuperType()
public static long	getTypeId(Class<?> clazz)
public boolean	hasAnnotation(Class<? extends Annotation> clazz)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	indexOf(String name)
pack-priv static boolean	isDefinedByJVM(long id)
public boolean	isDefinedByJVM()
public boolean	isInternal()
public static boolean	isKnownType(Class<?> type)
public boolean	isSimpleType()
public static boolean	isValidJavaFieldType(String name)
public boolean	isVisible()
pack-priv void	log(String action, LogTag logTag, LogLevel level)
pack-priv void	setAnnotations(List<AnnotationElement> annotations)
public void	setFields(List<ValueDescriptor> fields)
public void	setId(long id)
public void	setInternal(boolean internal)
public void	setRemove(boolean remove)
public void	setVisible(boolean visible)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv void	trimFields()
private String	typeText()

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

annos	back to summary
private final AnnotationConstruct annos

BOOLEAN	back to summary
pack-priv static final Type BOOLEAN

BYTE	back to summary
pack-priv static final Type BYTE

CHAR	back to summary
pack-priv static final Type CHAR

CLASS	back to summary
pack-priv static final Type CLASS

DOUBLE	back to summary
pack-priv static final Type DOUBLE

EVENT_NAME_PREFIX	back to summary
public static final String EVENT_NAME_PREFIX

fields	back to summary
private List<ValueDescriptor> fields

FLOAT	back to summary
pack-priv static final Type FLOAT

id	back to summary
private long id

INT	back to summary
pack-priv static final Type INT

internal	back to summary
private boolean internal

knownTypes	back to summary
private static final Map<Type, Class<?>> knownTypes

LONG	back to summary
pack-priv static final Type LONG

name	back to summary
private final String name

remove	back to summary
private boolean remove

SETTINGS_PREFIX	back to summary
public static final String SETTINGS_PREFIX

SHORT	back to summary
pack-priv static final Type SHORT

simpleType	back to summary
private Boolean simpleType

STACK_TRACE	back to summary
public static final Type STACK_TRACE

STRING	back to summary
pack-priv static final Type STRING

SUPER_TYPE_ANNOTATION	back to summary
public static final String SUPER_TYPE_ANNOTATION

SUPER_TYPE_EVENT	back to summary
public static final String SUPER_TYPE_EVENT

SUPER_TYPE_SETTING	back to summary
public static final String SUPER_TYPE_SETTING

superType	back to summary
private final String superType

THREAD	back to summary
pack-priv static final Type THREAD

TYPES_PREFIX	back to summary
public static final String TYPES_PREFIX

visible	back to summary
private boolean visible

Constructor Detail

Type	back to summary
public Type(String javaTypeName, String superType, long typeId) Creates a type Parameters javaTypeName:String i.e "java.lang.String" superType:String i.e "java.lang.Annotation" typeId:long the class id that represents the class in the JVM

Type

back to summary

public Type(String javaTypeName, String superType, long typeId)

Creates a type

Parameters

javaTypeName:String: i.e "java.lang.String"
superType:String: i.e "java.lang.Annotation"
typeId:long: the class id that represents the class in the JVM

Type	back to summary
pack-priv Type(String javaTypeName, String superType, long typeId, Boolean simpleType)

Method Detail

add	back to summary
public void add(ValueDescriptor valueDescriptor)

calculateSimpleType	back to summary
private boolean calculateSimpleType()

compareTo back to summary

compareTo	back to summary
public int compareTo(Type that) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Annotations @Override

public int compareTo(Type that)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

createKnownType	back to summary
private static Type createKnownType(Class<?> clazz)

createKnownType	back to summary
private static Type createKnownType(String name, Class<?> clazz)

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object object)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getAnnotation	back to summary
public <T> T getAnnotation(Class<? extends Annotation> clazz)

getAnnotationElements	back to summary
public List<AnnotationElement> getAnnotationElements()

getAnnotationValue	back to summary
public <T> T getAnnotationValue(Class<? extends Annotation> clazz, T defaultValue)

getDescription	back to summary
public String getDescription()

getField	back to summary
public ValueDescriptor getField(String name)

getFields	back to summary
public List<ValueDescriptor> getFields()

getId	back to summary
public long getId()

getKnownType	back to summary
public static Type getKnownType(String typeName)

getKnownType	back to summary
public static Type getKnownType(Class<?> clazz)

getKnownTypes	back to summary
pack-priv static Collection<Type> getKnownTypes()

getLabel	back to summary
public String getLabel()

getLogName	back to summary
public String getLogName()

getName	back to summary
public String getName()

getRemove	back to summary
public boolean getRemove()

getSuperType	back to summary
public String getSuperType()

getTypeId	back to summary
public static long getTypeId(Class<?> clazz)

hasAnnotation	back to summary
public boolean hasAnnotation(Class<? extends Annotation> clazz)

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

indexOf	back to summary
public int indexOf(String name)

isDefinedByJVM	back to summary
pack-priv static boolean isDefinedByJVM(long id)

isDefinedByJVM	back to summary
public boolean isDefinedByJVM()

isInternal	back to summary
public boolean isInternal()

isKnownType	back to summary
public static boolean isKnownType(Class<?> type)

isSimpleType	back to summary
public boolean isSimpleType()

isValidJavaFieldType	back to summary
public static boolean isValidJavaFieldType(String name)

isVisible	back to summary
public boolean isVisible()

log	back to summary
pack-priv void log(String action, LogTag logTag, LogLevel level)

setAnnotations	back to summary
pack-priv void setAnnotations(List<AnnotationElement> annotations)

setFields	back to summary
public void setFields(List<ValueDescriptor> fields)

setId	back to summary
public void setId(long id)

setInternal	back to summary
public void setInternal(boolean internal)

setRemove	back to summary
public void setRemove(boolean remove)

setVisible	back to summary
public void setVisible(boolean visible)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

trimFields	back to summary
pack-priv void trimFields()

typeText	back to summary
private String typeText()

public Class Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail