VarByte (MicroStream API)

java.lang.Object
- one.microstream.bytes.VarByte

All Implemented Interfaces:

Externalizable, Serializable
```
public final class VarByte
extends Object
implements Externalizable
```
See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`VarByte`	`add(boolean b)`
`VarByte`	`add(byte c)`
`VarByte`	`add(byte[] bytes)`
`VarByte`	`add(double d)`
`VarByte`	`add(float f)`
`VarByte`	`add(int i)`
`VarByte`	`add(long l)`
`VarByte`	`add(short s)`
`VarByte`	`add(String s)`
`VarByte`	`add(VarByte varByte)`
`VarByte`	`append(boolean value)`
`VarByte`	`append(byte value)`
`VarByte`	`append(byte[] bytes)`
`VarByte`	`append(byte[] bytes, int offset, int length)`
`VarByte`	`append(char value)`
`VarByte`	`append(double value)`
`VarByte`	`append(float value)`
`VarByte`	`append(int value)`
`VarByte`	`append(long value)`
`VarByte`	`append(short value)`
`VarByte`	`appendArray(byte... bytes)`
`VarByte`	`apply(Consumer<? super VarByte> procedure)`
`VarByte`	`clear()` Only preferable to `reset()` for security reasons.
`boolean`	`contains(byte c)`
`int`	`count(byte c)`
`VarByte`	`deleteByteAt(int index)`
`VarByte`	`deleteLast(int n)`
`VarByte`	`deleteLastByte()`
`void`	`ensureFreeCapacity(int requiredFreeCapacity)`
`byte`	`firstByte()`
`byte`	`get(int index)`
`void`	`getBytes(int srcBegin, int srcEnd, byte[] dst, int dstBegin)`
`static boolean`	`hasContent(VarByte varByte)`
`static boolean`	`hasNoContent(VarByte varByte)`
`int`	`indexOf(byte c)`
`int`	`indexOf(byte[] bytes)`
`int`	`indexOf(byte[] bytes, int offset)`
`int`	`indexOf(byte c, int fromIndex)`
`boolean`	`isEmpty()`
`byte`	`lastByte()`
`int`	`lastIndexOf(byte c)`
`int`	`lastIndexOf(byte c, int fromIndex)`
`int`	`length()`
`static VarByte`	`New()`
`static VarByte`	`New(int initialCapacity)` Use this constructor only if really a specific size is needed or of the text to be handled is really big. Otherwise, use the factory methods as they are faster due to skipping capacity checks and bounds adjustment.
`VarByte`	`printlnTo(PrintStream printStream)` Passes a copy of the internal byte array to the `PrintStream.println(String)` method of the passed `PrintStream` instance.
`VarByte`	`printTo(PrintStream printStream)` Passes a copy of the internal byte array to the `PrintStream.print(String)` method of the passed `PrintStream` instance.
`void`	`process(_byteProcedure processor)`
`void`	`readExternal(ObjectInput in)`
`VarByte`	`repeat(int amount, byte b)`
`VarByte`	`replaceFirst(byte sample, byte replacement)`
`VarByte`	`replaceFirst(int beginIndex, byte sample, byte replacement)`
`VarByte`	`reset()`
`VarByte`	`reverse()`
`VarByte`	`setByte(int index, byte c)`
`VarByte`	`setBytes(int index, byte... c)`
`VarByte`	`setLastByte(byte c)`
`VarByte`	`shrinkTo(int n)`
`VarByte`	`subsequence(int beginIndex, int endIndex)`
`VarByte`	`subSequence(int start, int end)`
`VarByte`	`surrogateByteReverse()` Deprecated. not implemented yet. Currently just does `reverse()`.
`byte[]`	`toByteArray()`
`String`	`toString()`
`String`	`toString(Charset charset)`
`void`	`trimToSize()`
`void`	`truncate()`
`void`	`writeExternal(ObjectOutput out)`

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

Method Detail

New
```
public static VarByte New()
```

New
```
public static VarByte New(int initialCapacity)
```
Use this constructor only if really a specific size is needed or of the text to be handled is really big.
Otherwise, use the factory methods as they are faster due to skipping capacity checks and bounds adjustment.

Note that the given initialCapacity will still be adjusted to the next higher 2^n bounding value.

Parameters:

initialCapacity - the initial size of the buffer

Returns:

a new VarByte instance

get
```
public byte get(int index)
```

lastByte
```
public byte lastByte()
```

firstByte
```
public byte firstByte()
```

length
```
public int length()
```

subSequence

public VarByte subSequence(int start,
                           int end)

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:: readExternal in interface Externalizable
Throws:: IOException; ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:: writeExternal in interface Externalizable
Throws:: IOException

toString
```
public String toString()
```
Overrides:

toString in class Object

toString

public String toString(Charset charset)
                throws UnsupportedEncodingException

Throws:: UnsupportedEncodingException

add
```
public VarByte add(boolean b)
```

add
```
public VarByte add(byte c)
```

add
```
public VarByte add(short s)
```

add
```
public VarByte add(int i)
```

add
```
public VarByte add(long l)
```

add
```
public VarByte add(float f)
```

add
```
public VarByte add(double d)
```

add
```
public VarByte add(byte[] bytes)
```

add
```
public VarByte add(String s)
```

add
```
public VarByte add(VarByte varByte)
```

ensureFreeCapacity

public void ensureFreeCapacity(int requiredFreeCapacity)

appendArray

public VarByte appendArray(byte... bytes)

append
```
public VarByte append(byte[] bytes)
```

append

public VarByte append(byte[] bytes,
                      int offset,
                      int length)

append
```
public VarByte append(byte value)
```

append
```
public VarByte append(boolean value)
```

append
```
public VarByte append(short value)
```

append
```
public VarByte append(char value)
```

append
```
public VarByte append(int value)
```

append
```
public VarByte append(float value)
```

append
```
public VarByte append(long value)
```

append
```
public VarByte append(double value)
```

setByte

public VarByte setByte(int index,
                       byte c)

setBytes

public VarByte setBytes(int index,
                        byte... c)

setLastByte
```
public VarByte setLastByte(byte c)
```

reverse
```
public VarByte reverse()
```

surrogateByteReverse
```
@Deprecated
public VarByte surrogateByteReverse()
```
Deprecated. not implemented yet. Currently just does reverse().

Not implemented yet.

Returns:

currenty exactely what reverse() returns.

See Also:

reverse()

indexOf
```
public int indexOf(byte c)
```

indexOf

public int indexOf(byte c,
                   int fromIndex)

indexOf
```
public int indexOf(byte[] bytes)
```

indexOf

public int indexOf(byte[] bytes,
                   int offset)

contains
```
public boolean contains(byte c)
```

lastIndexOf
```
public int lastIndexOf(byte c)
```

lastIndexOf

public int lastIndexOf(byte c,
                       int fromIndex)

count
```
public int count(byte c)
```

deleteByteAt

public VarByte deleteByteAt(int index)

deleteLastByte
```
public VarByte deleteLastByte()
```

deleteLast
```
public VarByte deleteLast(int n)
```

shrinkTo
```
public VarByte shrinkTo(int n)
```

toByteArray
```
public byte[] toByteArray()
```

getBytes

public void getBytes(int srcBegin,
                     int srcEnd,
                     byte[] dst,
                     int dstBegin)

isEmpty
```
public boolean isEmpty()
```

trimToSize
```
public void trimToSize()
```

hasNoContent
```
public static final boolean hasNoContent(VarByte varByte)
```
Parameters:

varByte - the VarByte to check

Returns:

true if varByte is either null or empty.

See Also:

isEmpty()

hasContent

public static final boolean hasContent(VarByte varByte)

replaceFirst

public VarByte replaceFirst(byte sample,
                            byte replacement)

replaceFirst

public VarByte replaceFirst(int beginIndex,
                            byte sample,
                            byte replacement)

subsequence

public VarByte subsequence(int beginIndex,
                           int endIndex)

process

public void process(_byteProcedure processor)

clear
```
public VarByte clear()
```
Only preferable to reset() for security reasons.

Returns:

this

reset
```
public final VarByte reset()
```

truncate
```
public void truncate()
```

printlnTo
```
public VarByte printlnTo(PrintStream printStream)
```
Passes a copy of the internal byte array to the PrintStream.println(String) method of the passed PrintStream instance.
The purpose of this method is to spare the unnecessary String instantiation of the generic method PrintStream.println(Object).

Parameters:

printStream - the PrintStream instance to be written to.

Returns:

this VarByte instance.

printTo
```
public VarByte printTo(PrintStream printStream)
```
Passes a copy of the internal byte array to the PrintStream.print(String) method of the passed PrintStream instance.
The purpose of this method is to spare the unnecessary String instantiation of the generic method PrintStream.println(Object).

Parameters:

printStream - the PrintStream instance to be written to.

Returns:

this VarByte instance.

repeat

public VarByte repeat(int amount,
                      byte b)

apply

public VarByte apply(Consumer<? super VarByte> procedure)

Class VarByte

Method Summary

Methods inherited from class java.lang.Object

Method Detail

New

New

get

lastByte

firstByte

length

subSequence

readExternal

writeExternal

toString

toString

add

add

add

add

add

add

add

add

add

add

ensureFreeCapacity

appendArray

append

append

append

append

append

append

append

append

append

append

setByte

setBytes

setLastByte

reverse

surrogateByteReverse

indexOf

indexOf

indexOf

indexOf

contains

lastIndexOf

lastIndexOf

count

deleteByteAt

deleteLastByte

deleteLast

shrinkTo

toByteArray

getBytes

isEmpty

trimToSize

hasNoContent

hasContent

replaceFirst

replaceFirst

subsequence

process

clear

reset

truncate

printlnTo

printTo

repeat

apply