Utf8String (quickbuf-runtime 1.4 API)

java.lang.Object
- us.hebi.quickbuf.Utf8String

```
public final class Utf8String
extends Object
```
Contains a string and its corresponding utf8 encoded byte sequence, and lazily converts between them when appropriate.

Since:

26 Nov 2019

Author:

Florian Enner

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`Utf8String`	`copyFrom(CharSequence other)` Holds on to immutable Strings and lazily encodes them, or encodes the sequence directly if it is not a String.
`Utf8String`	`copyFrom(String other)` Holds on to the reference of the String and encodes it when required.
`Utf8String`	`copyFrom(Utf8String other)`
`Utf8String`	`copyFromEncoded(CharSequence other)` Encodes the sequence immediately and does not hold on to the reference
`Utf8String`	`copyFromUtf8(byte[] bytes)`
`Utf8String`	`copyFromUtf8(byte[] bytes, int offset, int length)`
`void`	`ensureCapacity(int minimumCapacity)` Ensures that the capacity is at least equal to the specified minimum.
`Utf8String`	`ensureSerialized()` Makes sure that the content is in serialized form.
`boolean`	`equals(Object o)`
`StringBuilder`	`getChars(StringBuilder store)`
`String`	`getString()`
`String`	`getString(Utf8Decoder decoder)`
`int`	`hashCode()` Utf8Strings have no immutable state and should not be used in hashing structures.
`static Utf8String`	`newEmptyInstance()`
`static Utf8String`	`newEncodedInstance(CharSequence initialValue)`
`static Utf8String`	`newInstance(String initialValue)`
`int`	`size()`
`String`	`toString()`
`Utf8String`	`writeTo(ByteBuffer buffer)`
`Utf8String`	`writeTo(OutputStream outputStream)`
`Utf8String`	`writeTo(ProtoSink sink)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - newEmptyInstance
```
public static Utf8String newEmptyInstance()
```
  - newInstance
```
public static Utf8String newInstance(String initialValue)
```
  - newEncodedInstance
```
public static Utf8String newEncodedInstance(CharSequence initialValue)
```
  - size
```
public int size()
```
    Returns:
    
    size in encoded utf8 bytes
  - ensureSerialized
```
public Utf8String ensureSerialized()
```
    Makes sure that the content is in serialized form. This is a minor optimization in case you have commonly used string constants that should only be serialized once.
    
    Returns:
    
    this
  - getString
```
public String getString()
```
  - getString
```
public String getString(Utf8Decoder decoder)
```
  - getChars
```
public StringBuilder getChars(StringBuilder store)
```
  - copyFrom
```
public Utf8String copyFrom(CharSequence other)
```
    Holds on to immutable Strings and lazily encodes them, or encodes the sequence directly if it is not a String.
  - copyFromUtf8
```
public Utf8String copyFromUtf8(byte[] bytes)
```
  - copyFromUtf8
```
public Utf8String copyFromUtf8(byte[] bytes,
                               int offset,
                               int length)
```
  - copyFromEncoded
```
public Utf8String copyFromEncoded(CharSequence other)
```
    Encodes the sequence immediately and does not hold on to the reference
  - copyFrom
```
public Utf8String copyFrom(String other)
```
    Holds on to the reference of the String and encodes it when required.
  - copyFrom
```
public Utf8String copyFrom(Utf8String other)
```
  - writeTo
```
public Utf8String writeTo(ProtoSink sink)
                   throws IOException
```
    Throws:
    
    IOException
  - writeTo
```
public Utf8String writeTo(OutputStream outputStream)
                   throws IOException
```
    Throws:
    
    IOException
  - writeTo
```
public Utf8String writeTo(ByteBuffer buffer)
```
  - clear
```
public void clear()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Utf8Strings have no immutable state and should not be used in hashing structures. This method returns a constant value.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    0
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - ensureCapacity
```
public void ensureCapacity(int minimumCapacity)
```
    Ensures that the capacity is at least equal to the specified minimum. If the current capacity is less than the argument, then a new internal array is allocated with greater capacity. The new capacity is the larger of:
    - The minimumCapacity argument.
    - Twice the old capacity, plus 2.
    If the minimumCapacity argument is nonpositive, this method takes no action and simply returns. Note that subsequent operations on this object can reduce the actual capacity below that requested here.
    Parameters:
    
    minimumCapacity - the minimum desired capacity.

Class Utf8String

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newEmptyInstance

newInstance

newEncodedInstance

size

ensureSerialized

getString

getString

getChars

copyFrom

copyFromUtf8

copyFromUtf8

copyFromEncoded

copyFrom

copyFrom

writeTo

writeTo

writeTo

clear

equals

hashCode

toString

ensureCapacity