APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.jfr.internal.util

public final Record TimespanRate

extends Record
Class Inheritance
Record Components
rate:double 
periodNanos:long 
isRate:boolean 

A rate or fixed period, see jdk.jfr.internal.Rate

Field Summary

Modifier and TypeField and Description
private final boolean
isRate

Record Component accessed by isRate().

public static final TimespanRate
private final long
periodNanos

Record Component accessed by periodNanos().

private final double
rate

Record Component accessed by rate().

Constructor Summary

AccessConstructor and Description
public
TimespanRate(double rate, long periodNanos, boolean isRate)

Method Summary

Modifier and TypeMethod and Description
public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

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

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public boolean
isRate()

Record Component getter of isRate.

public static TimespanRate
of(String text)

Parses the rate string.

public long
periodNanos()

Record Component getter of periodNanos.

public double
rate()

Record Component getter of rate.

public static TimespanRate
private String
private String
public String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

isRateback to summary
private final boolean isRate

Record Component accessed by isRate().

OFFback to summary
public static final TimespanRate OFF
periodNanosback to summary
private final long periodNanos

Record Component accessed by periodNanos().

rateback to summary
private final double rate

Record Component accessed by rate().

Constructor Detail

TimespanRateback to summary
public TimespanRate(double rate, long periodNanos, boolean isRate)

Method Detail

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

isRateback to summary
public boolean isRate()

Record Component getter of isRate.

ofback to summary
public static TimespanRate of(String text)

Parses the rate string. Supports

  • off
  • time value like "1ms"
  • rate value like "10/s"
periodNanosback to summary
public long periodNanos()

Record Component getter of periodNanos.

rateback to summary
public double rate()

Record Component getter of rate.

selectHigherResolutionback to summary
public static TimespanRate selectHigherResolution(TimespanRate a, TimespanRate b)
toPeriodStringback to summary
private String toPeriodString()
toRateStringback to summary
private String toRateString()
toStringback to summary
public String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Annotations
@Override