W3cubDocs

/OpenJDK 21

Annotation Interface DataAmount

@Retention(RUNTIME) @Target({FIELD,TYPE,METHOD}) public @interface DataAmount
Event field annotation, specifies that a value represents an amount of data (for example, bytes).

The following example shows how the DataAmount annotation can be used to set the units BITS and BYTES to event fields.

@Name("com.example.ImageRender")
@Label("Image Render")
public class ImageRender extends Event {
    @Label("Height")
    long height;

    @Label("Width")
    long width;

    @Label("Color Depth")
    @DataAmount(DataAmount.BITS)
    int colorDepth;

    @Label("Memory Size")
    @DataAmount // bytes by default
    long memorySize;
}
Since:
9

Optional Element Summary

Modifier and Type Optional Element Description
String value
Returns the unit for the data amount, by default bytes.

Field Summary

Modifier and Type Field Description
static final String BITS
Unit for bits
static final String BYTES
Unit for bytes

Field Details

BITS

static final String BITS
Unit for bits
See Also:

BYTES

static final String BYTES
Unit for bytes
See Also:

Element Details

value

String value
Returns the unit for the data amount, by default bytes.
Returns:
the data amount unit, default BYTES, not null
Default:
"BYTES"

© 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/DataAmount.html