ArrayStoreBuffer (AMPS Java Client (5.3.2.1.6d15937f.540279))

java.lang.Object
- com.crankuptheamps.client.ArrayStoreBuffer

All Implemented Interfaces:

BlockPublishStore.Buffer, java.lang.AutoCloseable
```
public class ArrayStoreBuffer
extends java.lang.Object
implements BlockPublishStore.Buffer
```
ArrayStoreBuffer is a simple wrapper for a java array that maintains position. Very similar to the MemoryStoreBuffer, but instead of using a ByteBuffer, it just uses an array directly. Resize may be a tad more expensive, but steady-state latencies are significantly lower.

Constructor Summary

Constructors
Constructor and Description

ArrayStoreBuffer()

Constructors
Constructor and Description
`ArrayStoreBuffer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`byte[]`	`getBuffer()` Gets the back buffer.
`byte`	`getByte()` Gets the byte from the buffer.
`void`	`getBytes(BlockPublishStore.ByteSequence outBytes)` Gets the series of bytes at the current position by placing them into the provided `BlockPublishStore.ByteSequence` object.
`void`	`getBytes(Field outField, int length)` Gets the series of bytes at the current position, this is done by copying them into a `Field` object.
`int`	`getInt()` Gets the integer from the buffer.
`int`	`getInt(long position)` Gets the integer from the buffer.
`long`	`getLong()` Gets the long from the buffer.
`long`	`getPosition()` Gets the current position in the buffer.
`long`	`getSize()` Gets the size of the back buffer.
`void`	`putByte(byte b)` Writes the byte into the buffer.
`void`	`putBytes(BlockPublishStore.ByteSequence bytes)` Writes a series of bytes at the current position, taken from the specified `BlockPublishStore.ByteSequence`.
`void`	`putBytes(byte[] buffer, long position, long length)` Writes a series of bytes at the current position, taken from a byte array.
`void`	`putInt(int i)` Writes the integer into the buffer.
`void`	`putInt(long position, int i)` Puts the integer into the buffer.
`void`	`putLong(long l)` Writes the long into the buffer.
`void`	`putLong(long position, long l)` Writes the long into the buffer.
`void`	`setPosition(long position)` Sets the current position in the buffer.
`void`	`setSize(long newSize)` Sets the size of the back buffer.
`void`	`zero(long offset, int length)` Sets the buffer, offset, and length to 0.

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

- Constructor Detail
  - ArrayStoreBuffer
```
public ArrayStoreBuffer()
```
- Method Detail
  - getBuffer
```
public byte[] getBuffer()
```
    Gets the back buffer.
    
    Returns:
    
    The end buffer.
  - getSize
```
public long getSize()
             throws java.io.IOException
```
    Gets the size of the back buffer.
    
    Specified by:
    
    getSize in interface BlockPublishStore.Buffer
    
    Returns:
    
    Length of the buffer.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - setSize
```
public void setSize(long newSize)
             throws java.io.IOException
```
    Sets the size of the back buffer.
    
    Specified by:
    
    setSize in interface BlockPublishStore.Buffer
    
    Parameters:
    
    newSize - The number to be set as the new buffer size.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - getPosition
```
public long getPosition()
                 throws java.io.IOException
```
    Gets the current position in the buffer.
    
    Specified by:
    
    getPosition in interface BlockPublishStore.Buffer
    
    Returns:
    
    The current position.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - setPosition
```
public void setPosition(long position)
                 throws java.io.IOException
```
    Sets the current position in the buffer.
    
    Specified by:
    
    setPosition in interface BlockPublishStore.Buffer
    
    Parameters:
    
    position - The current position to set.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - putByte
```
public void putByte(byte b)
             throws java.io.IOException
```
    Writes the byte into the buffer.
    
    Specified by:
    
    putByte in interface BlockPublishStore.Buffer
    
    Parameters:
    
    b - The byte to place in the buffer.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - getByte
```
public byte getByte()
             throws java.io.IOException
```
    Gets the byte from the buffer.
    
    Specified by:
    
    getByte in interface BlockPublishStore.Buffer
    
    Returns:
    
    The byte from the buffer.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - putInt
```
public void putInt(int i)
            throws java.io.IOException
```
    Writes the integer into the buffer.
    
    Specified by:
    
    putInt in interface BlockPublishStore.Buffer
    
    Parameters:
    
    i - The integer to place in the buffer.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - putInt
```
public void putInt(long position,
                   int i)
            throws java.io.IOException
```
    Puts the integer into the buffer.
    
    Specified by:
    
    putInt in interface BlockPublishStore.Buffer
    
    Parameters:
    
    position - The position in the buffer to place the integer.
    
    i - The integer to place in the buffer.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - getInt
```
public int getInt()
           throws java.io.IOException
```
    Gets the integer from the buffer.
    
    Specified by:
    
    getInt in interface BlockPublishStore.Buffer
    
    Returns:
    
    The integer from the buffer.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - getInt
```
public int getInt(long position)
           throws java.io.IOException
```
    Gets the integer from the buffer.
    
    Specified by:
    
    getInt in interface BlockPublishStore.Buffer
    
    Parameters:
    
    position - The position in the buffer where the integer should begin.
    
    Returns:
    
    The integer from the buffer.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - putLong
```
public void putLong(long l)
             throws java.io.IOException
```
    Writes the long into the buffer.
    
    Specified by:
    
    putLong in interface BlockPublishStore.Buffer
    
    Parameters:
    
    l - The long to be placed in the buffer.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - putLong
```
public void putLong(long position,
                    long l)
             throws java.io.IOException
```
    Writes the long into the buffer.
    
    Specified by:
    
    putLong in interface BlockPublishStore.Buffer
    
    Parameters:
    
    position - The position where the long should be placed in the buffer.
    
    l - The long to be placed in the buffer.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - getLong
```
public long getLong()
             throws java.io.IOException
```
    Gets the long from the buffer.
    
    Specified by:
    
    getLong in interface BlockPublishStore.Buffer
    
    Returns:
    
    The long from the buffer.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - putBytes
```
public void putBytes(BlockPublishStore.ByteSequence bytes)
              throws java.io.IOException
```
    Writes a series of bytes at the current position, taken from the specified BlockPublishStore.ByteSequence.
    
    Specified by:
    
    putBytes in interface BlockPublishStore.Buffer
    
    Parameters:
    
    bytes - The series of bytes to write at the current position.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - getBytes
```
public void getBytes(BlockPublishStore.ByteSequence outBytes)
              throws java.io.IOException
```
    Gets the series of bytes at the current position by placing them into the provided BlockPublishStore.ByteSequence object.
    
    Specified by:
    
    getBytes in interface BlockPublishStore.Buffer
    
    Parameters:
    
    outBytes - The provided ByteSequence object.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - putBytes
```
public void putBytes(byte[] buffer,
                     long position,
                     long length)
              throws java.io.IOException
```
    Writes a series of bytes at the current position, taken from a byte array.
    
    Specified by:
    
    putBytes in interface BlockPublishStore.Buffer
    
    Parameters:
    
    buffer - The buffer containing a series of bytes.
    
    position - The position in the buffer where the series of bytes are located.
    
    length - The length of the byte buffer.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - getBytes
```
public void getBytes(Field outField,
                     int length)
              throws java.io.IOException
```
    Gets the series of bytes at the current position, this is done by copying them into a Field object.
    
    Specified by:
    
    getBytes in interface BlockPublishStore.Buffer
    
    Parameters:
    
    outField - The Field object used to copy the byte sequence.
    
    length - The length of the Field object.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - zero
```
public void zero(long offset,
                 int length)
          throws java.io.IOException
```
    Sets the buffer, offset, and length to 0.
    
    Specified by:
    
    zero in interface BlockPublishStore.Buffer
    
    Parameters:
    
    offset - The offset to set as 0.
    
    length - The length to set as 0.
    
    Throws:
    
    java.io.IOException - Not thrown from this implementation.
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.lang.AutoCloseable

Class ArrayStoreBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArrayStoreBuffer

Method Detail

getBuffer

getSize

setSize

getPosition

setPosition

putByte

getByte

putInt

putInt

getInt

getInt

putLong

putLong

getLong

putBytes

getBytes

putBytes

getBytes

zero

close