io.apiman.gateway.engine.io

Class ByteBuffer

java.lang.Object

io.apiman.gateway.engine.io.ByteBuffer

All Implemented Interfaces:

IApimanBuffer

public class ByteBuffer
extends Object
implements IApimanBuffer

A simple IApimanBuffer from a byte array. Don't use this class directly - create and manage buffers by using the IBufferFactoryComponent instead! The factory will give you a platform-specific buffer implementation.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
ByteBuffer(byte[] byteData)
ByteBuffer(byte[] buffer, int size) Constructor.
ByteBuffer(int size) Constructor.
ByteBuffer(String stringData) Constructor.
ByteBuffer(String stringData, String enc) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	append(byte b)
void	append(byte[] bytes)
void	append(byte[] bytes, int offset, int length) Byte array to append with given offset and length.
void	append(IApimanBuffer buffer)
void	append(IApimanBuffer buffer, int offset, int length)
void	append(String string)
void	append(String string, String encoding)
byte	get(int index)
byte[]	getBytes()
byte[]	getBytes(int start, int end) Get ApimanBuffer as byte array constrained by indices.
int	getBytesInBuffer()
Object	getNativeBuffer() Get encapsulated native buffer.
String	getString(int start, int end)
String	getString(int start, int end, String encoding)
void	insert(int index, byte[] b) Inserts data from byte array into the index location.
void	insert(int index, byte[] b, int offset, int length) Inserts data from the byte array constrained by offset and length.
void	insert(int index, IApimanBuffer buffer) Inserts data at given index with buffer.
void	insert(int index, IApimanBuffer buffer, int offset, int length) Inserts data at the given index with buffer at given offset and constrained length.
void	insert(int index, String string) Inserts data at index from value of string.
void	insert(int index, String string, String encoding) Inserts data at index from value of string.
int	length()
int	readFrom(InputStream stream) Reads from the input stream.
void	set(int index, byte b)
String	toString()
String	toString(String encoding)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ByteBuffer

public ByteBuffer(byte[] buffer,
          int size)

Constructor.

Parameters:

buffer -

size -

ByteBuffer

public ByteBuffer(int size)

Constructor.

Parameters:

size - initial size

ByteBuffer

public ByteBuffer(String stringData)

Constructor.

Parameters:

stringData - String data

ByteBuffer

public ByteBuffer(String stringData,
          String enc)

Constructor.

Parameters:

stringData - String data

enc - String data encoding

ByteBuffer

public ByteBuffer(byte[] byteData)

Parameters:

byteData - the byte data to initialize buffer

Method Detail

getNativeBuffer

public Object getNativeBuffer()

Description copied from interface: IApimanBuffer

Get encapsulated native buffer.

Specified by:

getNativeBuffer in interface IApimanBuffer

Returns:

Native buffer.

See Also:

IApimanBuffer.getNativeBuffer()

length

public int length()

Specified by:

length in interface IApimanBuffer

Returns:

Byte length of buffer.

See Also:

IApimanBuffer.length()

insert

public void insert(int index,
          IApimanBuffer buffer)

Description copied from interface: IApimanBuffer

Inserts data at given index with buffer.

Specified by:

insert in interface IApimanBuffer

See Also:

IApimanBuffer.insert(int, io.apiman.gateway.engine.io.IApimanBuffer)

insert

public void insert(int index,
          IApimanBuffer buffer,
          int offset,
          int length)

Description copied from interface: IApimanBuffer

Inserts data at the given index with buffer at given offset and constrained length.

Specified by:

insert in interface IApimanBuffer

Parameters:

index - ApimanBuffer index

buffer - Provided buffer

offset - Provided buffer offset index

length - Provided buffer maximum length to set

See Also:

IApimanBuffer.insert(int, io.apiman.gateway.engine.io.IApimanBuffer, int, int)

append

public void append(IApimanBuffer buffer)

Specified by:

append in interface IApimanBuffer

Parameters:

buffer - Buffer to append

See Also:

IApimanBuffer.append(io.apiman.gateway.engine.io.IApimanBuffer)

append

public void append(IApimanBuffer buffer,
          int offset,
          int length)

Specified by:

append in interface IApimanBuffer

Parameters:

buffer - Buffer to append

offset - Provided buffer offset

length - Provided buffer maximum length to append

See Also:

IApimanBuffer.append(io.apiman.gateway.engine.io.IApimanBuffer, int, int)

get

public byte get(int index)

Specified by:

get in interface IApimanBuffer

Parameters:

index - Index of byte to retrieve

Returns:

byte Value of byte at index

See Also:

IApimanBuffer.get(int)

set

public void set(int index,
       byte b)

Specified by:

set in interface IApimanBuffer

Parameters:

index - Index of byte to set

b - Byte value to set

See Also:

IApimanBuffer.set(int, byte)

append

public void append(byte b)

Specified by:

append in interface IApimanBuffer

Parameters:

b - Byte value to append

See Also:

IApimanBuffer.append(byte)

getBytes

public byte[] getBytes()

Specified by:

getBytes in interface IApimanBuffer

Returns:

ApimanBuffer as byte array.

See Also:

IApimanBuffer.getBytes()

getBytes

public byte[] getBytes(int start,
              int end)

Description copied from interface: IApimanBuffer

Get ApimanBuffer as byte array constrained by indices.

Specified by:

getBytes in interface IApimanBuffer

Parameters:

start - Start index inclusive

end - End index exclusive

Returns:

ApimanBuffer as byte array

See Also:

IApimanBuffer.getBytes(int, int)

insert

public void insert(int index,
          byte[] b)

Description copied from interface: IApimanBuffer

Inserts data from byte array into the index location.

Specified by:

insert in interface IApimanBuffer

Parameters:

index - Start index

b - Byte array to set

See Also:

IApimanBuffer.insert(int, byte[])

insert

public void insert(int index,
          byte[] b,
          int offset,
          int length)

Description copied from interface: IApimanBuffer

Inserts data from the byte array constrained by offset and length.

Specified by:

insert in interface IApimanBuffer

Parameters:

index - ApimanBuffer start index

b - Byte Array to set

offset - Byte array start index

length - Byte array maximum length to append

See Also:

IApimanBuffer.insert(int, byte[], int, int)

append

public void append(byte[] bytes)

Specified by:

append in interface IApimanBuffer

Parameters:

bytes - Byte array to append.

See Also:

IApimanBuffer.append(byte[])

append

public void append(byte[] bytes,
          int offset,
          int length)

Description copied from interface: IApimanBuffer

Byte array to append with given offset and length.

Specified by:

append in interface IApimanBuffer

Parameters:

bytes - Byte array to append

offset - Byte array start index

length - Maximum length to append

See Also:

IApimanBuffer.append(byte[], int, int)

getString

public String getString(int start,
               int end)

Specified by:

getString in interface IApimanBuffer

Parameters:

start - start index

end - end index

Returns:

String constrained by start and end indices

See Also:

IApimanBuffer.getString(int, int)

getString

public String getString(int start,
               int end,
               String encoding)

Specified by:

getString in interface IApimanBuffer

Parameters:

start - start index

end - end index

encoding - string encoding

Returns:

String constrained by start and end indices

See Also:

IApimanBuffer.getString(int, int, java.lang.String)

insert

public void insert(int index,
          String string)

Description copied from interface: IApimanBuffer

Inserts data at index from value of string.

Specified by:

insert in interface IApimanBuffer

Parameters:

index - ApimanBuffer index

string - String to set as bytes

See Also:

IApimanBuffer.insert(int, java.lang.String)

insert

public void insert(int index,
          String string,
          String encoding)

Description copied from interface: IApimanBuffer

Inserts data at index from value of string.

Specified by:

insert in interface IApimanBuffer

Parameters:

index - ApimanBuffer index

string - String to set as bytes

encoding - Encoding of string

See Also:

IApimanBuffer.insert(int, java.lang.String, java.lang.String)

append

public void append(String string)

Specified by:

append in interface IApimanBuffer

Parameters:

string - String to append

See Also:

IApimanBuffer.append(java.lang.String)

append

public void append(String string,
          String encoding)
            throws UnsupportedEncodingException

Specified by:

append in interface IApimanBuffer

Parameters:

string - String to append

encoding - Encoding of string

Throws:

UnsupportedEncodingException

See Also:

IApimanBuffer.append(java.lang.String, java.lang.String)

toString

public String toString(String encoding)

Specified by:

toString in interface IApimanBuffer

Parameters:

encoding - Encoding of string

Returns:

String ApimanBuffer as string of given encoding.

See Also:

IApimanBuffer.toString(java.lang.String)

toString

public String toString()

Specified by:

toString in interface IApimanBuffer

Overrides:

toString in class Object

Returns:

String representation of string.

See Also:

Object.toString()

getBytesInBuffer

public int getBytesInBuffer()

Returns:

the bytesInBuffer

readFrom

public int readFrom(InputStream stream)
             throws IOException

Reads from the input stream.

Parameters:

stream - the input stream to read from

Returns:

bytes read from buffer

Throws:

IOException - I/O error when reading from buffer