StoredValue (Lucene 10.5.0 core API)
Description: declaration: package: org.apache.lucene.document, class: StoredValue

Package org.apache.lucene.document

# Class StoredValue

java.lang.Object
org.apache.lucene.document.StoredValue

public final class StoredValue extends Object
Abstraction around a stored value.

See Also:
  - `IndexableField`

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Class
  Description
  `static enum`
  `StoredValue.Type`
  Type of a `StoredValue`.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `StoredValue(double value)`
  Ctor for double values.
  `StoredValue(float value)`
  Ctor for float values.
  `StoredValue(int value)`
  Ctor for integer values.
  `StoredValue(long value)`
  Ctor for long values.
  `StoredValue(String value)`
  Ctor for string values.
  `StoredValue(StoredFieldDataInput value)`
  Ctor for data input values.
  `StoredValue(BytesRef value)`
  Ctor for binary values.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `BytesRef`
  `getBinaryValue()`
  Retrieve a binary value.
  `StoredFieldDataInput`
  `getDataInputValue()`
  Retrieve a data input value.
  `double`
  `getDoubleValue()`
  Retrieve a double value.
  `float`
  `getFloatValue()`
  Retrieve a float value.
  `int`
  `getIntValue()`
  Retrieve an integer value.
  `long`
  `getLongValue()`
  Retrieve a long value.
  `String`
  `getStringValue()`
  Retrieve a string value.
  `StoredValue.Type`
  `getType()`
  Retrieve the type of the stored value.
  `void`
  `setBinaryValue(BytesRef value)`
  Set a binary value.
  `void`
  `setDataInputValue(StoredFieldDataInput value)`
  Set a data input value.
  `void`
  `setDoubleValue(double value)`
  Set a double value.
  `void`
  `setFloatValue(float value)`
  Set a float value.
  `void`
  `setIntValue(int value)`
  Set an integer value.
  `void`
  `setLongValue(long value)`
  Set a long value.
  `void`
  `setStringValue(String value)`
  Set a string value.

  ### Methods inherited from class java.lang.Object

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

- ## Constructor Details

  - ### StoredValue

    public StoredValue(int value)
    Ctor for integer values.

  - ### StoredValue

    public StoredValue(long value)
    Ctor for long values.

  - ### StoredValue

    public StoredValue(float value)
    Ctor for float values.

  - ### StoredValue

    public StoredValue(double value)
    Ctor for double values.

  - ### StoredValue

    public StoredValue(BytesRef value)
    Ctor for binary values.

  - ### StoredValue

    public StoredValue(StoredFieldDataInput value)
    Ctor for data input values.

  - ### StoredValue

    public StoredValue(String value)
    Ctor for string values.

- ## Method Details

  - ### getType

    public StoredValue.Type getType()
    Retrieve the type of the stored value.

  - ### setIntValue

    public void setIntValue(int value)
    Set an integer value.

  - ### setLongValue

    public void setLongValue(long value)
    Set a long value.

  - ### setFloatValue

    public void setFloatValue(float value)
    Set a float value.

  - ### setDoubleValue

    public void setDoubleValue(double value)
    Set a double value.

  - ### setBinaryValue

    public void setBinaryValue(BytesRef value)
    Set a binary value.

  - ### setDataInputValue

    public void setDataInputValue(StoredFieldDataInput value)
    Set a data input value.

  - ### setStringValue

    public void setStringValue(String value)
    Set a string value.

  - ### getIntValue

    public int getIntValue()
    Retrieve an integer value.

  - ### getLongValue

    public long getLongValue()
    Retrieve a long value.

  - ### getFloatValue

    public float getFloatValue()
    Retrieve a float value.

  - ### getDoubleValue

    public double getDoubleValue()
    Retrieve a double value.

  - ### getBinaryValue

    public BytesRef getBinaryValue()
    Retrieve a binary value.

  - ### getDataInputValue

    public StoredFieldDataInput getDataInputValue()
    Retrieve a data input value.

  - ### getStringValue

    public String getStringValue()
    Retrieve a string value.