org.msgpack.value
Interface MapCursor

All Superinterfaces:

ValueRef

All Known Subinterfaces:

MapValue

All Known Implementing Classes:

MapCursorImpl, MapValueImpl

public interface MapCursor
extends ValueRef

Cursor for traversing map value entries. This cursor reports a sequence of key and value pairs.

Method Summary

boolean	hasNext() Test whether this cursor can point to a next key or value.
ValueRef	nextKeyOrValue() Retrieves a reference to the next key or value.
int	size()
void	skipAll() Skips all of the remaining keys and values.
void	skipKeyOrValue() Skips a next key or value
MapValue	toValue() Create an immutable value from this reference

Methods inherited from interface org.msgpack.value.ValueRef

accept, asBinary, asBoolean, asExtended, asFloat, asInteger, asNil, asNumber, asRaw, asString, getArrayCursor, getMapCursor, getValueType, isArray, isBinary, isBoolean, isExtended, isFloat, isInteger, isMap, isNil, isNumber, isRaw, isRef, isString, writeTo

Method Detail

size

int size()

hasNext

boolean hasNext()

Test whether this cursor can point to a next key or value.

Returns:

nextKeyOrValue

ValueRef nextKeyOrValue()

Retrieves a reference to the next key or value.

Returns:

skipKeyOrValue

void skipKeyOrValue()

Skips a next key or value

skipAll

void skipAll()

Skips all of the remaining keys and values.

toValue

MapValue toValue()

Description copied from interface: ValueRef

Create an immutable value from this reference

Specified by:

toValue in interface ValueRef

Returns: