RrdString

java.lang.Object

org.rrd4j.core.RrdPrimitive

org.rrd4j.core.RrdString

Type Parameters:: U - The type of RrdUpdater this primitive belongs to

class RrdString>extends RrdPrimitive

RRD primitive type for handling string values.

This class provides methods to store and retrieve string values in RRD files. It includes caching support for performance optimization when the backend allows it.

Field Summary
Fields
Modifier and Type
Field
Description
private String
cache
The last value read, when caching is enabled.
Fields inherited from class RrdPrimitive
RRD_DOUBLE, RRD_INT, RRD_LONG, RRD_PRIM_SIZES, RRD_STRING, STRING_LENGTH
Modifier and Type
Field
Description
(package private) static final int
RRD_DOUBLE
Type identifier for double RRD primitives.
(package private) static final int
RRD_INT
Type identifier for integer RRD primitives.
(package private) static final int
RRD_LONG
Type identifier for long RRD primitives.
(package private) static final int[]
RRD_PRIM_SIZES
Array containing the size in bytes for each RRD primitive type.
(package private) static final int
RRD_STRING
Type identifier for string RRD primitives.
(package private) static final int
STRING_LENGTH
Maximum length of string values stored in RRD primitives.
Constructor Summary
Constructors
Constructor
Description
RrdString(RrdUpdater updater)
Create a varying string-valued primitive.
RrdString(RrdUpdater updater, boolean isConstant)
Create a string-valued primitive.
Method Summary
All Methods
Modifier and Type
Method
Description
(package private) String
get()
Retrieve the stored string value.
(package private) void
set(String value)
Store a string value with optional caching.
Methods inherited from class RrdPrimitive
isCachingAllowed, readBytes, readDouble, readDouble, readDouble, readEnum, readInt, readLong, readString, writeBytes, writeDouble, writeDouble, writeDouble, writeDouble, writeEnum, writeInt, writeLong, writeString
Modifier and Type
Method
Description
(package private) final boolean
isCachingAllowed()
Checks if caching is allowed for this primitive.
(package private) final byte[]
readBytes()
Raw byte array from backend storage.
(package private) final double
readDouble()
Reads the double value from backend storage.
(package private) final double
readDouble(int index)
Position in the primitive array.
(package private) final double[]
readDouble(int index, int count)
Starting position in the primitive array.
protected final <E extends Enum<E>> E
readEnum(Class<E> clazz)
Deserialize an enum value from backend storage.
(package private) final int
readInt()
Reads the int value from backend storage.
(package private) final long
readLong()
Reads the long value from backend storage.
(package private) final String
readString()
Reads the string value from backend storage.
(package private) final void
writeBytes(byte[] b)
Byte array to write to backend storage.
(package private) final void
writeDouble(double value)
Double value to write to backend storage.
(package private) final void
writeDouble(int index, double value)
Position in the primitive array.
(package private) final void
writeDouble(int index, double[] values)
Starting position in the primitive array.
(package private) final void
writeDouble(int index, double value, int count)
Starting position in the primitive array.
protected final <E extends Enum<E>> void
writeEnum(E value)
Serialize an enum value to backend storage.
(package private) final void
writeInt(int value)
Int value to write to backend storage.
(package private) final void
writeLong(long value)
Long value to write to backend storage.
(package private) final void
writeString(String value)
String value to write to backend storage.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- cache
  private String cache
  The last value read, when caching is enabled.
Constructor Details
- RrdString
 RrdString(RrdUpdater updater, boolean isConstant)
 Create a string-valued primitive.
 Parameters:
 updater - the source of values
 isConstant - true to read a constant rather than a varying value
- RrdString
 RrdString(RrdUpdater updater)
 Create a varying string-valued primitive.
 Parameters:
 updater - the source of values
Method Details
- set
  void set(String value) throws IOException
  Store a string value with optional caching.
  Parameters:
  value - the string value to set
  Throws:
  IOException - if an I/O error occurs
- get
  String get() throws IOException
  Retrieve the stored string value.
  Returns:
  the stored string
  Throws:
  IOException - if an I/O error occurs

Field Summary

Fields inherited from class RrdPrimitive

Constructor Summary

Method Summary

Methods inherited from class RrdPrimitive

Methods inherited from class Object

Field Details

cache

Constructor Details

RrdString

Method Details

set

get