org.openjdk.jmc.common.unit

Class TimestampKind

java.lang.Object

org.openjdk.jmc.common.unit.ContentType<IQuantity>

org.openjdk.jmc.common.unit.KindOfQuantity<TimestampUnit>

org.openjdk.jmc.common.unit.TimestampKind

All Implemented Interfaces:

IDescribable, IType<IQuantity>, IConstraint<IQuantity>, IPersister<IQuantity>

class TimestampKind
extends KindOfQuantity<TimestampUnit>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TimestampKind.FractionFormatter
private static class	TimestampKind.LegacyAndFractionFormatter
private static class	TimestampKind.LegacyFormatter

Nested classes/interfaces inherited from class org.openjdk.jmc.common.unit.KindOfQuantity

KindOfQuantity.ExactFormatter<U extends TypedUnit<U>>, KindOfQuantity.VerboseFormatter<U extends TypedUnit<U>>

Field Summary

Fields

Modifier and Type	Field and Description
private static FormatThreadLocal<java.text.DateFormat>	DATE_TIME_FORMATTER_HOLDER
private static IFormatter<IQuantity>	HOUR_TO_MICROS_FORMATTER
private static IFormatter<IQuantity>	HOUR_TO_MILLIS_FORMATTER
private static IFormatter<IQuantity>	HOUR_TO_NANOS_FORMATTER
private static IFormatter<IQuantity>	HOUR_TO_SECONDS_FORMATTER
(package private) static TimestampKind	INSTANCE
private static IFormatter<IQuantity>	MICROS_FORMATTER
(package private) static TimestampUnit	MICROS_UNIT
private static IFormatter<IQuantity>	MILLIS_FORMATTER
(package private) static TimestampUnit	MILLIS_UNIT
private static IFormatter<IQuantity>	NANOS_FORMATTER
(package private) static TimestampUnit	NANOS_UNIT
private static java.util.regex.Pattern	NUMBER_UNIT_PATTERN
(package private) static TimestampUnit	SECONDS_UNIT
private static IFormatter<IQuantity>	YEAR_TO_DAY_FORMATTER
private static IFormatter<IQuantity>	YEAR_TO_MICROS_FORMATTER
private static IFormatter<IQuantity>	YEAR_TO_MILLIS_FORMATTER
private static IFormatter<IQuantity>	YEAR_TO_NANOS_FORMATTER
private static IFormatter<IQuantity>	YEAR_TO_SECONDS_FORMATTER

Fields inherited from class org.openjdk.jmc.common.unit.ContentType

m_identifier

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TimestampKind()

Method Summary

Modifier and Type	Method and Description
static TimestampKind	buildContentType(LinearKindOfQuantity timespan)
(package private) static java.text.DateFormat	getDateTimeFormatter() Only for formatting, not parsing!
TimestampUnit	getDefaultUnit()
KindOfQuantity<LinearUnit>	getDeltaKind()
IFormatter<IQuantity>	getFormatterResolving(IRange<IQuantity> range) Get a formatter with sufficient resolution to produce unique strings for both ends of range, and consecutive equally spaced quantities.
TimestampUnit	getLargestExactUnit(IQuantity value) Get the largest unit, if any, in which this quantity can be expressed exactly, typically with an integer.
TimestampUnit	getPreferredUnit(IQuantity value, double minNumericalValue, double maxNumericalValue)
ITypedQuantity<TimestampUnit>	parseInteractive(java.lang.String interactiveQuantity) Parse an interactive string.
ITypedQuantity<TimestampUnit>	parsePersisted(java.lang.String persistedQuantity) Parse a persisted string.
private static java.text.DateFormat	patchYear(java.text.DateFormat df)

Methods inherited from class org.openjdk.jmc.common.unit.KindOfQuantity

addUnit, combine, format, getAccessor, getAccessorKeys, getAllUnits, getAttributes, getCommonUnits, getFirstBucket, getFirstBucket, getPersister, getRangeFormatter, getUnit, interactiveFormat, persistableString, resolveLocalizedName, resolveLocalizedSymbol, validate

Methods inherited from class org.openjdk.jmc.common.unit.ContentType

addFormatter, getDefaultFormatter, getDescription, getFormatter, getFormatters, getIdentifier, getName, hasAttribute, lookupNameFor, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NUMBER_UNIT_PATTERN

private static final java.util.regex.Pattern NUMBER_UNIT_PATTERN

DATE_TIME_FORMATTER_HOLDER

private static final FormatThreadLocal<java.text.DateFormat> DATE_TIME_FORMATTER_HOLDER

NANOS_UNIT

static TimestampUnit NANOS_UNIT

MICROS_UNIT

static TimestampUnit MICROS_UNIT

MILLIS_UNIT

static TimestampUnit MILLIS_UNIT

SECONDS_UNIT

static TimestampUnit SECONDS_UNIT

INSTANCE

static TimestampKind INSTANCE

YEAR_TO_DAY_FORMATTER

private static IFormatter<IQuantity> YEAR_TO_DAY_FORMATTER

YEAR_TO_SECONDS_FORMATTER

private static IFormatter<IQuantity> YEAR_TO_SECONDS_FORMATTER

YEAR_TO_MILLIS_FORMATTER

private static IFormatter<IQuantity> YEAR_TO_MILLIS_FORMATTER

YEAR_TO_MICROS_FORMATTER

private static IFormatter<IQuantity> YEAR_TO_MICROS_FORMATTER

YEAR_TO_NANOS_FORMATTER

private static IFormatter<IQuantity> YEAR_TO_NANOS_FORMATTER

HOUR_TO_SECONDS_FORMATTER

private static IFormatter<IQuantity> HOUR_TO_SECONDS_FORMATTER

HOUR_TO_MILLIS_FORMATTER

private static IFormatter<IQuantity> HOUR_TO_MILLIS_FORMATTER

HOUR_TO_MICROS_FORMATTER

private static IFormatter<IQuantity> HOUR_TO_MICROS_FORMATTER

HOUR_TO_NANOS_FORMATTER

private static IFormatter<IQuantity> HOUR_TO_NANOS_FORMATTER

MILLIS_FORMATTER

private static IFormatter<IQuantity> MILLIS_FORMATTER

MICROS_FORMATTER

private static IFormatter<IQuantity> MICROS_FORMATTER

NANOS_FORMATTER

private static IFormatter<IQuantity> NANOS_FORMATTER

Constructor Detail

TimestampKind

private TimestampKind()

Method Detail

patchYear

private static java.text.DateFormat patchYear(java.text.DateFormat df)

getDateTimeFormatter

static java.text.DateFormat getDateTimeFormatter()

Only for formatting, not parsing!

buildContentType

public static TimestampKind buildContentType(LinearKindOfQuantity timespan)

getPreferredUnit

public TimestampUnit getPreferredUnit(IQuantity value,
                                      double minNumericalValue,
                                      double maxNumericalValue)

Specified by:

getPreferredUnit in class KindOfQuantity<TimestampUnit>

getLargestExactUnit

public TimestampUnit getLargestExactUnit(IQuantity value)

Description copied from class: KindOfQuantity

Get the largest unit, if any, in which this quantity can be expressed exactly, typically with an integer. If the quantity has zero magnitude (quantity.doubleValue() == 0.0), quantity.getUnit() will be returned. Thus, if you want to find out a maximum common unit for a set of quantities (not recommended), only use the non-zero quantities.

Note that this may be a fairly expensive operation, and isn't intended to be used excessively. The only valid use case is for guessing the original unit in which a quantity was expressed, after it has been stored or transmitted using a legacy mechanism with a fixed unit.

Specified by:

getLargestExactUnit in class KindOfQuantity<TimestampUnit>

Returns:

a unit or null

getFormatterResolving

public IFormatter<IQuantity> getFormatterResolving(IRange<IQuantity> range)

Description copied from class: KindOfQuantity

Get a formatter with sufficient resolution to produce unique strings for both ends of range, and consecutive equally spaced quantities. The returned formatter might implement IIncrementalFormatter, in which case its method can be used to reduce redundant information between adjacent quantities.

Specified by:

getFormatterResolving in class KindOfQuantity<TimestampUnit>

getDeltaKind

public KindOfQuantity<LinearUnit> getDeltaKind()

Specified by:

getDeltaKind in class KindOfQuantity<TimestampUnit>

getDefaultUnit

public TimestampUnit getDefaultUnit()

Specified by:

getDefaultUnit in class KindOfQuantity<TimestampUnit>

parsePersisted

public ITypedQuantity<TimestampUnit> parsePersisted(java.lang.String persistedQuantity)
                                             throws QuantityConversionException

Description copied from class: KindOfQuantity

Parse a persisted string. Only guaranteed to be able to parse strings produced by IQuantity.persistableString() for quantities of this kind of quantity. Only use this on persisted strings, never for interactive input.

Specified by:

parsePersisted in interface IConstraint<IQuantity>

Specified by:

parsePersisted in class KindOfQuantity<TimestampUnit>

Parameters:

persistedQuantity - persisted string to parse

Returns:

a valid quantity for this kind of quantity

Throws:

QuantityConversionException - if parsing failed

parseInteractive

public ITypedQuantity<TimestampUnit> parseInteractive(java.lang.String interactiveQuantity)
                                               throws QuantityConversionException

Description copied from class: KindOfQuantity

Parse an interactive string. Only guaranteed to be able to parse strings produced by IQuantity.interactiveFormat() for quantities of this kind of quantity and in the same locale. Only use this for interactive input, never for persisted strings.

Specified by:

parseInteractive in interface IConstraint<IQuantity>

Specified by:

parseInteractive in class KindOfQuantity<TimestampUnit>

Parameters:

interactiveQuantity - interactive string to parse

Returns:

a valid quantity for this kind of quantity

Throws:

QuantityConversionException - if parsing failed