MutableValueStr (Lucene 10.5.0 core API)
Description: declaration: package: org.apache.lucene.util.mutable, class: MutableValueStr

Package org.apache.lucene.util.mutable

# Class MutableValueStr

java.lang.Object
org.apache.lucene.util.mutable.MutableValue
org.apache.lucene.util.mutable.MutableValueStr

All Implemented Interfaces:
  `Comparable<MutableValue>`

public class MutableValueStr extends MutableValue
`MutableValue` implementation of type `String`. When mutating instances of this object, the caller is responsible for ensuring that any instance where `exists` is set to `false` must also have a `value` with a length set to 0.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `BytesRefBuilder`
  `value`

  ### Fields inherited from class org.apache.lucene.util.mutable.MutableValue

  `exists`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `MutableValueStr()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `compareSameType(Object other)`
  `void`
  `copy(MutableValue source)`
  `MutableValue`
  `duplicate()`
  `boolean`
  `equalsSameType(Object other)`
  `int`
  `hashCode()`
  `Object`
  `toObject()`

  ### Methods inherited from class org.apache.lucene.util.mutable.MutableValue

  `compareTo, equals, exists, toString`

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

  `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- ## Field Details

  - ### value

    public BytesRefBuilder value

- ## Constructor Details

  - ### MutableValueStr

    public MutableValueStr()

- ## Method Details

  - ### toObject

    public Object toObject()
    Specified by:
      `toObject` in class `MutableValue`

  - ### copy

    public void copy(MutableValue source)
    Specified by:
      `copy` in class `MutableValue`

  - ### duplicate

    public MutableValue duplicate()
    Specified by:
      `duplicate` in class `MutableValue`

  - ### equalsSameType

    public boolean equalsSameType(Object other)
    Specified by:
      `equalsSameType` in class `MutableValue`

  - ### compareSameType

    public int compareSameType(Object other)
    Specified by:
      `compareSameType` in class `MutableValue`

  - ### hashCode

    public int hashCode()
    Specified by:
      `hashCode` in class `MutableValue`