com.neeve.sma

Class MessageTransportHeaders.Header

java.lang.Object

com.neeve.sma.MessageTransportHeaders.Header

Enclosing class:

MessageTransportHeaders

public final class MessageTransportHeaders.Header
extends Object

Represent a message transport header name/value pair.

Threading:

A Header is not safe for concurrent access by multiple threads.

Constructor Summary

Constructors

Constructor and Description
MessageTransportHeaders.Header()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getBinaryValue() Get the byte[] value of this header.
int	getBinaryValueTo(ByteBuffer target) Get the binary contents of the header value to the provided ByteBuffer.
int	getBinaryValueTo(com.neeve.io.IOBuffer target, int offset) Get the binary contents of the header value to the provided IOBuffer.
int	getBinaryValueTo(com.neeve.io.IOElasticBuffer target, int offset) Get the binary contents of the header value to the provided IOElasticBuffer.
boolean	getBooleanValue() Get the boolean value of this header.
short	getByteValue() Get the byte value of this header.
char	getCharValue() Get the h value of this header.
double	getDoubleValue() Get the double value of this header.
int	getEncodedValueLength() Returns the encoded length of a value.
float	getFloatValue() Get the float value of this header.
int	getIntValue() Get the int value of this header.
long	getLongValue() Returns the header value casting it or converting it to a long if possible.
String	getName() Gets the name of the header property.
XString	getNameUnsafe() Gets the name of the header property.
short	getShortValue() Get the short value of this header.
String	getStringValue() Gets the String value of the field.
void	getStringValueTo(XString target) Sets the header value as a string into the provided XString.
XString	getStringValueUnsafe() Gets the header property value.
MessageTransportHeaders.HeaderType	getType()
Object	getValue() Gets the header property value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageTransportHeaders.Header

public MessageTransportHeaders.Header()

Method Detail

getNameUnsafe

public final XString getNameUnsafe()

Gets the name of the header property. Note that as Header instances are reused it is illegal to hold on to the returned value while iterating transport headers.

Returns:

The name of the header property.

getName

public final String getName()

Gets the name of the header property.

This operation is not zero garbage. Use getNameUnsafe() for zero garbage access to the header name.

Returns:

The name of the header property.

getType

public final MessageTransportHeaders.HeaderType getType()

Returns:

The header type.

getStringValueUnsafe

public final XString getStringValueUnsafe()

Gets the header property value.

Note that as Header instances are reused it is illegal to hold on to the returned value while iterating transport headers.

Returns:

The value of the header property as an XString

getStringValueTo

public final void getStringValueTo(XString target)

Sets the header value as a string into the provided XString.

Note that as Header instances are reused it is illegal to hold on to the returned value while iterating transport headers.

getStringValue

public String getStringValue()

Gets the String value of the field.

If the type of the header is not a String the value is converted to a String.

This method is not zero garbage

Returns:

The String value of the field.

getLongValue

public long getLongValue()

Returns the header value casting it or converting it to a long if possible.

Returns:

The value of the header property as a long.

Throws:

NumberFormatException - if the type of the header can't be converted to a long.

getIntValue

public int getIntValue()

Get the int value of this header.

If the header is not of type MessageTransportHeaders.HeaderType.Int, the value will be downcast.

Returns:

The value of the header property as an int (or cast to an int).

Throws:

NumberFormatException - if the type of the header can't be converted to a int.

getShortValue

public short getShortValue()

Get the short value of this header.

If the header is not of type MessageTransportHeaders.HeaderType.Short, the value will be downcast.

Returns:

The value of the header property as an int (or cast to an short).

Throws:

NumberFormatException - if the type of the header can't be converted to a short.

getByteValue

public short getByteValue()

Get the byte value of this header.

If the header is not of type MessageTransportHeaders.HeaderType.Byte, the value will be downcast.

Returns:

The value of the header property as an int (or cast to an byte).

Throws:

NumberFormatException - if the type of the header can't be converted to a byte.

getBinaryValue

public byte[] getBinaryValue()

Get the byte[] value of this header.

If the header is not of type MessageTransportHeaders.HeaderType.Binary, the value will be downcast.

Returns:

The value of the header property as an int (or cast to an byte).

Throws:

IllegalArgumentException - if the header is not of type MessageTransportHeaders.HeaderType.Binary

getEncodedValueLength

public int getEncodedValueLength()

Returns the encoded length of a value.

Returns:

The encoded length of a value.

getBinaryValueTo

public int getBinaryValueTo(com.neeve.io.IOElasticBuffer target,
                   int offset)

Get the binary contents of the header value to the provided IOElasticBuffer.

Parameters:

target - The target buffer to copy into.

offset - The offset into the target buffer at which to copy.

Returns:

The number of bytes written.

getBinaryValueTo

public int getBinaryValueTo(com.neeve.io.IOBuffer target,
                   int offset)

Get the binary contents of the header value to the provided IOBuffer.

Callers may call getEncodedValueLength() to determine the number of bytes that must be remaining in the target buffer for this call to succeed.

Parameters:

target - The target buffer to copy into.

offset - The offset into the target buffer at which to copy.

Returns:

The number of bytes written.

getBinaryValueTo

public int getBinaryValueTo(ByteBuffer target)

Get the binary contents of the header value to the provided ByteBuffer.

Callers may call getEncodedValueLength() to determine the number of bytes that must be remaining in the target buffer for this call to succeed.

Callers may call getEncodedValueLength() to determine the number of bytes that must be remaining in the target buffer for the call to succeed.

Parameters:

target - The target buffer to copy into.

Returns:

The number of bytes written.

Throws:

IllegalArgumentException - if the header is not of type MessageTransportHeaders.HeaderType.Binary

getBooleanValue

public boolean getBooleanValue()

Get the boolean value of this header.

If the header is of type String and the value is "true" or "TRUE" then true is returned, otherwise true is only returned if the header type is Boolean and true.

Returns:

The value of the header property as a boolean

getCharValue

public char getCharValue()

Get the h value of this header.

Note that only ascii characters are currently supported.

Returns:

The value of the header property as a boolean

getDoubleValue

public double getDoubleValue()

Get the double value of this header.

If the header is not of type MessageTransportHeaders.HeaderType.Double, the value will be downcast.

Returns:

The value of the header property as an int (or cast to an double).

Throws:

NumberFormatException - if the type of the header can't be converted to a double.

getFloatValue

public float getFloatValue()

Get the float value of this header.

If the header is not of type MessageTransportHeaders.HeaderType.Float, the value will be downcast.

Returns:

The value of the header property as an int (or cast to an float).

Throws:

NumberFormatException - if the type of the header can't be converted to a float.

getValue

public final Object getValue()

Gets the header property value. Note this method is not zero garbage

Returns:

The value of the header property as a long