Page (embulk-api 0.10.31 API)

java.lang.Object
- org.embulk.spi.Page

```
public abstract class Page
extends Object
```
An in-process (in-JVM) container of data records.
It serializes records to byte[] (in Buffer) for the following purposes.
- A) Avoid slowness by handling many Java Objects
- B) Avoid complexity by type-safe primitive arrays
- C) Track memory consumption by records
- D) Use off-heap memory
(C) and (D) may not be so meaningful as of Embulk v0.7+ (or since earlier) as recent Embulk unlikely allocates so many Pages at the same time. Recent Embulk is streaming-driven instead of multithreaded queue-based.
Page is NOT for inter-process communication. For multi-process execution such as the deprecated MapReduce Executor, the executor plugin takes responsibility about interoperable serialization.
Since:

0.4.0

Constructor Summary

Constructors
Constructor and Description

Page()

Constructors
Constructor and Description
`Page()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Page`	`allocate(int length)` Deprecated. It is to be removed, implemented only for compatibility. Plugins should no longer call it directly.
`abstract Buffer`	`buffer()`
`abstract String`	`getStringReference(int index)`
`abstract List<String>`	`getStringReferences()`
`abstract org.msgpack.value.ImmutableValue`	`getValueReference(int index)`
`abstract List<org.msgpack.value.ImmutableValue>`	`getValueReferences()`
`abstract void`	`release()`
`abstract Page`	`setStringReferences(List<String> values)`
`abstract Page`	`setValueReferences(List<org.msgpack.value.ImmutableValue> values)`
`static Page`	`wrap(Buffer buffer)` Deprecated. It is to be removed, implemented only for compatibility. Plugins should no longer call it directly.

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

- Constructor Detail
  - Page
```
public Page()
```
- Method Detail
  - setStringReferences
```
public abstract Page setStringReferences(List<String> values)
```
    Since:
    
    0.4.0
  - setValueReferences
```
public abstract Page setValueReferences(List<org.msgpack.value.ImmutableValue> values)
```
    Since:
    
    0.8.0
  - getStringReferences
```
public abstract List<String> getStringReferences()
```
    Since:
    
    0.6.0
  - getValueReferences
```
public abstract List<org.msgpack.value.ImmutableValue> getValueReferences()
```
    Since:
    
    0.8.0
  - getStringReference
```
public abstract String getStringReference(int index)
```
    Since:
    
    0.4.0
  - getValueReference
```
public abstract org.msgpack.value.ImmutableValue getValueReference(int index)
```
    Since:
    
    0.8.0
  - release
```
public abstract void release()
```
    Since:
    
    0.4.0
  - buffer
```
public abstract Buffer buffer()
```
    Since:
    
    0.4.0
  - allocate
```
@Deprecated
public static Page allocate(int length)
```
    Deprecated. It is to be removed, implemented only for compatibility. Plugins should no longer call it directly.
    
    Creates a new Page instance.
    
    Parameters:
    
    length - length of the internal Buffer of the created Page
    
    Returns:
    
    Page created
    
    Since:
    
    0.4.0
  - wrap
```
@Deprecated
public static Page wrap(Buffer buffer)
```
    Deprecated. It is to be removed, implemented only for compatibility. Plugins should no longer call it directly.
    
    Creates a new Page instance wrapping an internal Buffer.
    
    Parameters:
    
    buffer - the internal Buffer
    
    Returns:
    
    Page created
    
    Since:
    
    0.4.0

Class Page

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Page

Method Detail

setStringReferences

setValueReferences

getStringReferences

getValueReferences

getStringReference

getValueReference

release

buffer

allocate

wrap