io.apiman.gateway.engine.io

Interface IApimanBuffer

public interface IApimanBuffer

A generic buffer used throughout APIMan, principally for streaming body chunks. Each implementing platform should attempt to implement this in a manner which is as efficient as practicable. Heavily inspired by Vert.x's Buffer interface, which serves an almost identical purpose. Implementors are advised to use getNativeBuffer() where possible to reduce repackaging overhead.

Author:

Marc Savy

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.
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()
void	set(int index, byte b)
String	toString()
String	toString(String encoding)

Method Detail

getNativeBuffer

Object getNativeBuffer()

Get encapsulated native buffer.

Returns:

Native buffer.

length

int length()

Returns:

Byte length of buffer.

insert

void insert(int index,
          IApimanBuffer buffer)

Inserts data at given index with buffer.

Parameters:

index -

buffer -

insert

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

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

Parameters:

index - ApimanBuffer index

buffer - Provided buffer

offset - Provided buffer offset index

length - Provided buffer maximum length to set

append

void append(IApimanBuffer buffer)

Parameters:

buffer - Buffer to append

append

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

Parameters:

buffer - Buffer to append

offset - Provided buffer offset

length - Provided buffer maximum length to append

get

byte get(int index)

Parameters:

index - Index of byte to retrieve

Returns:

byte Value of byte at index

Throws:

IndexOutOfBoundsException

set

void set(int index,
       byte b)

Parameters:

index - Index of byte to set

b - Byte value to set

append

void append(byte b)

Parameters:

b - Byte value to append

getBytes

byte[] getBytes()

Returns:

ApimanBuffer as byte array.

getBytes

byte[] getBytes(int start,
              int end)

Get ApimanBuffer as byte array constrained by indices.

Parameters:

start - Start index inclusive

end - End index exclusive

Returns:

ApimanBuffer as byte array

insert

void insert(int index,
          byte[] b)

Inserts data from byte array into the index location.

Parameters:

index - Start index

b - Byte array to set

insert

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

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

Parameters:

index - ApimanBuffer start index

b - Byte Array to set

offset - Byte array start index

length - Byte array maximum length to append

append

void append(byte[] bytes)

Parameters:

bytes - Byte array to append.

append

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

Byte array to append with given offset and length.

Parameters:

bytes - Byte array to append

offset - Byte array start index

length - Maximum length to append

getString

String getString(int start,
               int end)

Parameters:

start - start index

end - end index

Returns:

String constrained by start and end indices

getString

String getString(int start,
               int end,
               String encoding)
                 throws UnsupportedEncodingException

Parameters:

start - start index

end - end index

encoding - string encoding

Returns:

String constrained by start and end indices

Throws:

UnsupportedEncodingException

insert

void insert(int index,
          String string)

Inserts data at index from value of string.

Parameters:

index - ApimanBuffer index

string - String to set as bytes

insert

void insert(int index,
          String string,
          String encoding)
            throws UnsupportedEncodingException

Inserts data at index from value of string.

Parameters:

index - ApimanBuffer index

string - String to set as bytes

string - Encoding of string

Throws:

UnsupportedEncodingException

append

void append(String string)

Parameters:

string - String to append

append

void append(String string,
          String encoding)
            throws UnsupportedEncodingException

Parameters:

string - String to append

encoding - Encoding of string

Throws:

UnsupportedEncodingException

toString

String toString()

Overrides:

toString in class Object

Returns:

String representation of string.

toString

String toString(String encoding)
                throws UnsupportedEncodingException

Parameters:

encoding - Encoding of string

Returns:

String ApimanBuffer as string of given encoding.

Throws:

UnsupportedEncodingException