FlexBuffers (FlatBuffers Java API 1.12.0 API)

java.lang.Object
- com.google.flatbuffers.FlexBuffers

public class FlexBuffers
extends Object

This class can be used to parse FlexBuffer messages.

For generating FlexBuffer messages, use FlexBuffersBuilder.

Example of usage:

 ReadBuf bb = ... // load message from file or network
 FlexBuffers.Reference r = FlexBuffers.getRoot(bb); // Reads the root element
 FlexBuffers.Map map = r.asMap(); // We assumed root object is a map
 System.out.println(map.get("name").asString()); // prints element with key "name"

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FlexBuffers.Blob` Represents a array of bytes element in the buffer
`static class`	`FlexBuffers.FlexBufferException`
`static class`	`FlexBuffers.Key` Represents a key element in the buffer.
`static class`	`FlexBuffers.KeyVector` Represent a vector of keys in a map
`static class`	`FlexBuffers.Map` Map object representing a set of key-value pairs.
`static class`	`FlexBuffers.Reference` Represents an generic element in the buffer.
`static class`	`FlexBuffers.TypedVector` Object that represents a set of elements with the same type
`static class`	`FlexBuffers.Vector` Object that represents a set of elements in the buffer

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FBT_BLOB` Represent a blob type
`static int`	`FBT_BOOL` Represent a boolean type
`static int`	`FBT_FLOAT` Represent a float type
`static int`	`FBT_INDIRECT_FLOAT` Represent a indirect float type
`static int`	`FBT_INDIRECT_INT` Represent a indirect signed integer type
`static int`	`FBT_INDIRECT_UINT` Represent a indirect unsigned integer type
`static int`	`FBT_INT` Represent a signed integer type
`static int`	`FBT_KEY` Represent a key to a map type
`static int`	`FBT_MAP` Represent a map type
`static int`	`FBT_NULL` Represent a null type
`static int`	`FBT_STRING` Represent a string type
`static int`	`FBT_UINT` Represent a unsigned type
`static int`	`FBT_VECTOR` Represent a vector type
`static int`	`FBT_VECTOR_BOOL` Represent a vector of booleans type
`static int`	`FBT_VECTOR_FLOAT` Represent a vector of floats type
`static int`	`FBT_VECTOR_FLOAT2`
`static int`	`FBT_VECTOR_FLOAT3`
`static int`	`FBT_VECTOR_FLOAT4`
`static int`	`FBT_VECTOR_INT` Represent a vector of signed integers type
`static int`	`FBT_VECTOR_INT2`
`static int`	`FBT_VECTOR_INT3`
`static int`	`FBT_VECTOR_INT4`
`static int`	`FBT_VECTOR_KEY` Represent a vector of keys type
`static int`	`FBT_VECTOR_STRING_DEPRECATED` Represent a vector of strings type
`static int`	`FBT_VECTOR_UINT` Represent a vector of unsigned integers type
`static int`	`FBT_VECTOR_UINT2`
`static int`	`FBT_VECTOR_UINT3`
`static int`	`FBT_VECTOR_UINT4`

Constructor Summary

Constructors
Constructor and Description

FlexBuffers()

Constructors
Constructor and Description
`FlexBuffers()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static FlexBuffers.Reference`	`getRoot(ByteBuffer buffer)` Deprecated.
`static FlexBuffers.Reference`	`getRoot(com.google.flatbuffers.ReadBuf buffer)` Reads a FlexBuffer message in ReadBuf and returns `FlexBuffers.Reference` to the root element.

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

- Field Detail
  - FBT_NULL
```
public static final int FBT_NULL
```
    Represent a null type
    
    See Also:
    
    Constant Field Values
  - FBT_INT
```
public static final int FBT_INT
```
    Represent a signed integer type
    
    See Also:
    
    Constant Field Values
  - FBT_UINT
```
public static final int FBT_UINT
```
    Represent a unsigned type
    
    See Also:
    
    Constant Field Values
  - FBT_FLOAT
```
public static final int FBT_FLOAT
```
    Represent a float type
    
    See Also:
    
    Constant Field Values
  - FBT_KEY
```
public static final int FBT_KEY
```
    Represent a key to a map type
    
    See Also:
    
    Constant Field Values
  - FBT_STRING
```
public static final int FBT_STRING
```
    Represent a string type
    
    See Also:
    
    Constant Field Values
  - FBT_INDIRECT_INT
```
public static final int FBT_INDIRECT_INT
```
    Represent a indirect signed integer type
    
    See Also:
    
    Constant Field Values
  - FBT_INDIRECT_UINT
```
public static final int FBT_INDIRECT_UINT
```
    Represent a indirect unsigned integer type
    
    See Also:
    
    Constant Field Values
  - FBT_INDIRECT_FLOAT
```
public static final int FBT_INDIRECT_FLOAT
```
    Represent a indirect float type
    
    See Also:
    
    Constant Field Values
  - FBT_MAP
```
public static final int FBT_MAP
```
    Represent a map type
    
    See Also:
    
    Constant Field Values
  - FBT_VECTOR
```
public static final int FBT_VECTOR
```
    Represent a vector type
    
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_INT
```
public static final int FBT_VECTOR_INT
```
    Represent a vector of signed integers type
    
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_UINT
```
public static final int FBT_VECTOR_UINT
```
    Represent a vector of unsigned integers type
    
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_FLOAT
```
public static final int FBT_VECTOR_FLOAT
```
    Represent a vector of floats type
    
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_KEY
```
public static final int FBT_VECTOR_KEY
```
    Represent a vector of keys type
    
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_STRING_DEPRECATED
```
public static final int FBT_VECTOR_STRING_DEPRECATED
```
    Represent a vector of strings type
    
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_INT2
```
public static final int FBT_VECTOR_INT2
```
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_UINT2
```
public static final int FBT_VECTOR_UINT2
```
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_FLOAT2
```
public static final int FBT_VECTOR_FLOAT2
```
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_INT3
```
public static final int FBT_VECTOR_INT3
```
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_UINT3
```
public static final int FBT_VECTOR_UINT3
```
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_FLOAT3
```
public static final int FBT_VECTOR_FLOAT3
```
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_INT4
```
public static final int FBT_VECTOR_INT4
```
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_UINT4
```
public static final int FBT_VECTOR_UINT4
```
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_FLOAT4
```
public static final int FBT_VECTOR_FLOAT4
```
    See Also:
    
    Constant Field Values
  - FBT_BLOB
```
public static final int FBT_BLOB
```
    Represent a blob type
    
    See Also:
    
    Constant Field Values
  - FBT_BOOL
```
public static final int FBT_BOOL
```
    Represent a boolean type
    
    See Also:
    
    Constant Field Values
  - FBT_VECTOR_BOOL
```
public static final int FBT_VECTOR_BOOL
```
    Represent a vector of booleans type
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FlexBuffers
```
public FlexBuffers()
```
- Method Detail
  - getRoot
```
@Deprecated
public static FlexBuffers.Reference getRoot(ByteBuffer buffer)
```
    Deprecated.
    
    Reads a FlexBuffer message in ReadBuf and returns FlexBuffers.Reference to the root element.
    
    Parameters:
    
    buffer - ReadBuf containing FlexBuffer message
    
    Returns:
    
    FlexBuffers.Reference to the root object
  - getRoot
```
public static FlexBuffers.Reference getRoot(com.google.flatbuffers.ReadBuf buffer)
```
    Reads a FlexBuffer message in ReadBuf and returns FlexBuffers.Reference to the root element.
    
    Parameters:
    
    buffer - ReadBuf containing FlexBuffer message
    
    Returns:
    
    FlexBuffers.Reference to the root object

Class FlexBuffers

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FBT_NULL

FBT_INT

FBT_UINT

FBT_FLOAT

FBT_KEY

FBT_STRING

FBT_INDIRECT_INT

FBT_INDIRECT_UINT

FBT_INDIRECT_FLOAT

FBT_MAP

FBT_VECTOR

FBT_VECTOR_INT

FBT_VECTOR_UINT

FBT_VECTOR_FLOAT

FBT_VECTOR_KEY

FBT_VECTOR_STRING_DEPRECATED

FBT_VECTOR_INT2

FBT_VECTOR_UINT2

FBT_VECTOR_FLOAT2

FBT_VECTOR_INT3

FBT_VECTOR_UINT3

FBT_VECTOR_FLOAT3

FBT_VECTOR_INT4

FBT_VECTOR_UINT4

FBT_VECTOR_FLOAT4

FBT_BLOB

FBT_BOOL

FBT_VECTOR_BOOL

Constructor Detail

FlexBuffers

Method Detail

getRoot

getRoot