BufferFacadeFactory.ByteBufferFacade (KDG Commons 1.0.17 API)

java.lang.Object
- net.sf.kdgcommons.buffer.BufferFacadeFactory.ByteBufferFacade

All Implemented Interfaces:

BufferFacade

Enclosing class:

BufferFacadeFactory
```
public static class BufferFacadeFactory.ByteBufferFacade
extends Object
implements BufferFacade
```
A facade for a standard Java ByteBuffer.

Constructor Summary

Constructors
Constructor and Description

ByteBufferFacade(ByteBuffer buf)

ByteBufferFacade(ByteBuffer buf, int base)

Constructors
Constructor and Description
`ByteBufferFacade(ByteBuffer buf)`
`ByteBufferFacade(ByteBuffer buf, int base)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`capacity()` Returns the capacity of the wrapped buffer.
`byte`	`get(long index)` Returns the single byte at the specified index (relative to the relocation base).
`byte[]`	`getBytes(long index, int len)` Returns an array containing the `len` bytes starting at the specified index (relative to the relocation base).
`char`	`getChar(long index)` Returns the 2-byte `char` value at the specified index (relative to the relocation base).
`double`	`getDouble(long index)` Returns the 8-byte `double` value at the specified index (relative to the relocation base).
`float`	`getFloat(long index)` Returns the 4-byte `float` value at the specified index (relative to the relocation base).
`int`	`getInt(long index)` Returns the 4-byte `int` value at the specified index (relative to the relocation base).
`long`	`getLong(long index)` Returns the 8-byte `long` value at the specified index (relative to the relocation base).
`short`	`getShort(long index)` Returns the 2-byte `short` value at the specified index (relative to the relocation base).
`long`	`limit()` Returns the limit of the buffer: the highest legal index + 1.
`void`	`put(long index, byte value)` Updates the single byte at the specified index (relative to the relocation base).
`void`	`putBytes(long index, byte[] value)` Inserts the specified array into the buffer, starting at the given index (relative to the relocation base).
`void`	`putChar(long index, char value)` Sets the 2-byte `char` value at the specified index (relative to the relocation base).
`void`	`putDouble(long index, double value)` Sets the 8-byte `double` value at the specified index (relative to the relocation base).
`void`	`putFloat(long index, float value)` Sets the 4-byte `float` value at the specified index (relative to the relocation base).
`void`	`putInt(long index, int value)` Sets the 4-byte `int` value at the specified index (relative to the relocation base).
`void`	`putLong(long index, long value)` Sets the 8-byte `long` value at the specified index (relative to the relocation base).
`void`	`putShort(long index, short value)` Sets the 2-byte `short` value at the specified index (relative to the relocation base).
`ByteBuffer`	`slice(long index)` Returns a `ByteBuffer` that represents a slice of the underlying buffer (ie, shares the same backing store), starting at the given index (relative to the relocation base) and extending to the end of the underlying buffer.

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

- Constructor Detail
  - ByteBufferFacade
```
public ByteBufferFacade(ByteBuffer buf)
```
  - ByteBufferFacade
```
public ByteBufferFacade(ByteBuffer buf,
                        int base)
```
- Method Detail
  - get
```
public byte get(long index)
```
    Description copied from interface: BufferFacade
    
    Returns the single byte at the specified index (relative to the relocation base).
    
    Specified by:
    
    get in interface BufferFacade
  - put
```
public void put(long index,
                byte value)
```
    Description copied from interface: BufferFacade
    
    Updates the single byte at the specified index (relative to the relocation base).
    
    Specified by:
    
    put in interface BufferFacade
  - getShort
```
public short getShort(long index)
```
    Description copied from interface: BufferFacade
    
    Returns the 2-byte short value at the specified index (relative to the relocation base).
    
    Specified by:
    
    getShort in interface BufferFacade
  - putShort
```
public void putShort(long index,
                     short value)
```
    Description copied from interface: BufferFacade
    
    Sets the 2-byte short value at the specified index (relative to the relocation base).
    
    Specified by:
    
    putShort in interface BufferFacade
  - getInt
```
public int getInt(long index)
```
    Description copied from interface: BufferFacade
    
    Returns the 4-byte int value at the specified index (relative to the relocation base).
    
    Specified by:
    
    getInt in interface BufferFacade
  - putInt
```
public void putInt(long index,
                   int value)
```
    Description copied from interface: BufferFacade
    
    Sets the 4-byte int value at the specified index (relative to the relocation base).
    
    Specified by:
    
    putInt in interface BufferFacade
  - getLong
```
public long getLong(long index)
```
    Description copied from interface: BufferFacade
    
    Returns the 8-byte long value at the specified index (relative to the relocation base).
    
    Specified by:
    
    getLong in interface BufferFacade
  - putLong
```
public void putLong(long index,
                    long value)
```
    Description copied from interface: BufferFacade
    
    Sets the 8-byte long value at the specified index (relative to the relocation base).
    
    Specified by:
    
    putLong in interface BufferFacade
  - getFloat
```
public float getFloat(long index)
```
    Description copied from interface: BufferFacade
    
    Returns the 4-byte float value at the specified index (relative to the relocation base).
    
    Specified by:
    
    getFloat in interface BufferFacade
  - putFloat
```
public void putFloat(long index,
                     float value)
```
    Description copied from interface: BufferFacade
    
    Sets the 4-byte float value at the specified index (relative to the relocation base).
    
    Specified by:
    
    putFloat in interface BufferFacade
  - getDouble
```
public double getDouble(long index)
```
    Description copied from interface: BufferFacade
    
    Returns the 8-byte double value at the specified index (relative to the relocation base).
    
    Specified by:
    
    getDouble in interface BufferFacade
  - putDouble
```
public void putDouble(long index,
                      double value)
```
    Description copied from interface: BufferFacade
    
    Sets the 8-byte double value at the specified index (relative to the relocation base).
    
    Specified by:
    
    putDouble in interface BufferFacade
  - getChar
```
public char getChar(long index)
```
    Description copied from interface: BufferFacade
    
    Returns the 2-byte char value at the specified index (relative to the relocation base).
    
    Specified by:
    
    getChar in interface BufferFacade
  - putChar
```
public void putChar(long index,
                    char value)
```
    Description copied from interface: BufferFacade
    
    Sets the 2-byte char value at the specified index (relative to the relocation base).
    
    Specified by:
    
    putChar in interface BufferFacade
  - getBytes
```
public byte[] getBytes(long index,
                       int len)
```
    Description copied from interface: BufferFacade
    
    Returns an array containing the len bytes starting at the specified index (relative to the relocation base).
    
    Specified by:
    
    getBytes in interface BufferFacade
  - putBytes
```
public void putBytes(long index,
                     byte[] value)
```
    Description copied from interface: BufferFacade
    
    Inserts the specified array into the buffer, starting at the given index (relative to the relocation base).
    
    Specified by:
    
    putBytes in interface BufferFacade
  - slice
```
public ByteBuffer slice(long index)
```
    Description copied from interface: BufferFacade
    
    Returns a ByteBuffer that represents a slice of the underlying buffer (ie, shares the same backing store), starting at the given index (relative to the relocation base) and extending to the end of the underlying buffer.
    The semantics of this method depend on the underlying buffer. For a normal ByteBuffer, the limit will be determined by the size of the original buffer. For a MappedFileBuffer, the limit will depend on the particular segment containing the offset.
    
    Specified by:
    
    slice in interface BufferFacade
  - capacity
```
public long capacity()
```
    Description copied from interface: BufferFacade
    
    Returns the capacity of the wrapped buffer.
    
    Specified by:
    
    capacity in interface BufferFacade
  - limit
```
public long limit()
```
    Description copied from interface: BufferFacade
    
    Returns the limit of the buffer: the highest legal index + 1. Will be ≤ BufferFacade.capacity().
    Support for this method will depend on the underlying buffer's support for limits. MappedFileBuffer does not support limits, and will always return capacity. The non-threadsafe facade created by BufferFacadeFactory does support limits, but the threadsafe facade only supports limits that were set before the first facade method was invoked (because it clones the buffer).
    
    Specified by:
    
    limit in interface BufferFacade

Class BufferFacadeFactory.ByteBufferFacade

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteBufferFacade

ByteBufferFacade

Method Detail

get

put

getShort

putShort

getInt

putInt

getLong

putLong

getFloat

putFloat

getDouble

putDouble

getChar

putChar

getBytes

putBytes

slice

capacity

limit