VPackSlice (ArangoDB Velocypack 2.5.4 API)

java.lang.Object
- com.arangodb.velocypack.VPackSlice

All Implemented Interfaces:

Serializable
```
public class VPackSlice
extends Object
implements Serializable
```
Author:

Mark Vollmary

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static VPackAttributeTranslator attributeTranslator

static VPackSlice NONE_SLICE

Fields
Modifier and Type	Field and Description
`static VPackAttributeTranslator`	`attributeTranslator`
`static VPackSlice`	`NONE_SLICE`

Constructor Summary

Constructors
Modifier Constructor and Description

protected VPackSlice()

VPackSlice(byte[] vpack)

VPackSlice(byte[] vpack, int start)

Constructors
Modifier	Constructor and Description
`protected`	`VPackSlice()`
	`VPackSlice(byte[] vpack)`
	`VPackSlice(byte[] vpack, int start)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Iterator<VPackSlice>`	`arrayIterator()`
`boolean`	`equals(Object obj)`
`protected int`	`findDataOffset()` Must be called for a nonempty array or object at start():
`VPackSlice`	`get(int index)`
`VPackSlice`	`get(String attribute)`
`BigDecimal`	`getAsBigDecimal()`
`BigInteger`	`getAsBigInteger()`
`byte[]`	`getAsBinary()`
`boolean`	`getAsBoolean()`
`byte`	`getAsByte()`
`char`	`getAsChar()`
`Date`	`getAsDate()`
`double`	`getAsDouble()`
`float`	`getAsFloat()`
`int`	`getAsInt()`
`long`	`getAsLong()`
`Number`	`getAsNumber()`
`short`	`getAsShort()`
`Date`	`getAsSQLDate()`
`Timestamp`	`getAsSQLTimestamp()`
`String`	`getAsString()`
`VPackStringSlice`	`getAsStringSlice()`
`int`	`getBinaryLength()`
`byte[]`	`getBuffer()`
`int`	`getByteSize()`
`long`	`getFirstTag()`
`int`	`getLength()`
`VPackSlice`	`getNth(int index)`
`String`	`getSchemaDescription()`
`int`	`getStart()`
`List<Long>`	`getTags()`
`ValueType`	`getType()`
`int`	`getValueStart()`
`int`	`hashCode()`
`boolean`	`hasTag(long tagId)`
`byte`	`head()`
`boolean`	`isArray()`
`boolean`	`isBCD()`
`boolean`	`isBinary()`
`boolean`	`isBoolean()`
`boolean`	`isByte()`
`boolean`	`isCustom()`
`boolean`	`isDate()`
`boolean`	`isDouble()`
`boolean`	`isExternal()`
`boolean`	`isFalse()`
`boolean`	`isIllegal()`
`boolean`	`isInt()`
`boolean`	`isInteger()`
`boolean`	`isMaxKey()`
`boolean`	`isMinKey()`
`boolean`	`isNone()`
`boolean`	`isNull()`
`boolean`	`isNumber()`
`boolean`	`isObject()`
`boolean`	`isSmallInt()`
`boolean`	`isString()`
`boolean`	`isTagged()`
`boolean`	`isTrue()`
`boolean`	`isType(ValueType type)`
`boolean`	`isUInt()`
`VPackSlice`	`keyAt(int index)`
`protected VPackSlice`	`makeKey()`
`Iterator<Map.Entry<String,VPackSlice>>`	`objectIterator()`
`int`	`size()`
`byte[]`	`toByteArray()`
`String`	`toString()`
`protected VPackSlice`	`translateUnchecked()` translates an integer key into a string, without checks
`VPackSlice`	`value()`
`VPackSlice`	`valueAt(int index)`

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

Field Detail

NONE_SLICE

public static final VPackSlice NONE_SLICE

attributeTranslator

public static final VPackAttributeTranslator attributeTranslator

Constructor Detail

VPackSlice
```
protected VPackSlice()
```

VPackSlice
```
public VPackSlice(byte[] vpack)
```

VPackSlice

public VPackSlice(byte[] vpack,
                  int start)

Method Detail

head
```
public byte head()
```

getBuffer
```
public byte[] getBuffer()
```

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

VPackSlice buffer without trailing zeros

getStart
```
public int getStart()
```

getValueStart
```
public int getValueStart()
```

value
```
public VPackSlice value()
```

getType
```
public ValueType getType()
```

isType

public boolean isType(ValueType type)

isNone
```
public boolean isNone()
```

isNull
```
public boolean isNull()
```

isIllegal
```
public boolean isIllegal()
```

isBoolean
```
public boolean isBoolean()
```

isTrue
```
public boolean isTrue()
```

isFalse
```
public boolean isFalse()
```

isArray
```
public boolean isArray()
```

isObject
```
public boolean isObject()
```

isDouble
```
public boolean isDouble()
```

isDate
```
public boolean isDate()
```

isExternal
```
public boolean isExternal()
```

isMinKey
```
public boolean isMinKey()
```

isMaxKey
```
public boolean isMaxKey()
```

isInt
```
public boolean isInt()
```

isUInt
```
public boolean isUInt()
```

isSmallInt
```
public boolean isSmallInt()
```

isInteger
```
public boolean isInteger()
```

isByte
```
public boolean isByte()
```

isNumber
```
public boolean isNumber()
```

isString
```
public boolean isString()
```

isBinary
```
public boolean isBinary()
```

isBCD
```
public boolean isBCD()
```

isCustom
```
public boolean isCustom()
```

isTagged
```
public boolean isTagged()
```

getFirstTag
```
public long getFirstTag()
```

getTags
```
public List<Long> getTags()
```

hasTag
```
public boolean hasTag(long tagId)
```

getAsBoolean
```
public boolean getAsBoolean()
```

getAsDouble
```
public double getAsDouble()
```

getAsBigDecimal
```
public BigDecimal getAsBigDecimal()
```

getAsNumber
```
public Number getAsNumber()
```

getAsLong
```
public long getAsLong()
```

getAsInt
```
public int getAsInt()
```

getAsFloat
```
public float getAsFloat()
```

getAsShort
```
public short getAsShort()
```

getAsByte
```
public byte getAsByte()
```

getAsBigInteger
```
public BigInteger getAsBigInteger()
```

getAsDate
```
public Date getAsDate()
```

getAsSQLDate
```
public Date getAsSQLDate()
```

getAsSQLTimestamp
```
public Timestamp getAsSQLTimestamp()
```

getAsString
```
public String getAsString()
```

getAsStringSlice

public VPackStringSlice getAsStringSlice()

getAsChar
```
public char getAsChar()
```

getAsBinary
```
public byte[] getAsBinary()
```

getBinaryLength
```
public int getBinaryLength()
```

getLength
```
public int getLength()
```
Returns:

the number of members for an Array, Object or String

size
```
public int size()
```

findDataOffset
```
protected int findDataOffset()
```
Must be called for a nonempty array or object at start():

getByteSize
```
public int getByteSize()
```

get
```
public VPackSlice get(int index)
```
Returns:

array value at the specified index

Throws:

VPackValueTypeException

get

public VPackSlice get(String attribute)
               throws VPackException

Throws:: VPackException

translateUnchecked
```
protected VPackSlice translateUnchecked()
```
translates an integer key into a string, without checks

makeKey

protected VPackSlice makeKey()
                      throws VPackKeyTypeException,
                             VPackNeedAttributeTranslatorException

Throws:: VPackKeyTypeException; VPackNeedAttributeTranslatorException

keyAt
```
public VPackSlice keyAt(int index)
```

valueAt
```
public VPackSlice valueAt(int index)
```

getNth
```
public VPackSlice getNth(int index)
```

arrayIterator

public Iterator<VPackSlice> arrayIterator()

objectIterator

public Iterator<Map.Entry<String,VPackSlice>> objectIterator()

getSchemaDescription
```
public String getSchemaDescription()
```
Returns:

a pretty-printable schema of the VPackSlice, for debug purposes only

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

toString in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

Class VPackSlice

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE_SLICE

attributeTranslator

Constructor Detail

VPackSlice

VPackSlice

VPackSlice

Method Detail

head

getBuffer

toByteArray

getStart

getValueStart

value

getType

isType

isNone

isNull

isIllegal

isBoolean

isTrue

isFalse

isArray

isObject

isDouble

isDate

isExternal

isMinKey

isMaxKey

isInt

isUInt

isSmallInt

isInteger

isByte

isNumber

isString

isBinary

isBCD

isCustom

isTagged

getFirstTag

getTags

hasTag

getAsBoolean

getAsDouble

getAsBigDecimal

getAsNumber

getAsLong

getAsInt

getAsFloat

getAsShort

getAsByte

getAsBigInteger

getAsDate

getAsSQLDate

getAsSQLTimestamp

getAsString

getAsStringSlice

getAsChar

getAsBinary

getBinaryLength

getLength

size

findDataOffset

getByteSize

get

get

translateUnchecked

makeKey

keyAt

valueAt

getNth

arrayIterator

objectIterator

getSchemaDescription