nl.teslanet.mule.connectors.coap.internal.options

Class DefaultBytesValue

java.lang.Object

nl.teslanet.mule.connectors.coap.api.binary.BytesValue

nl.teslanet.mule.connectors.coap.internal.options.DefaultBytesValue

All Implemented Interfaces:

Serializable, Comparable<BytesValue>

Direct Known Subclasses:

DefaultEntityTag

public class DefaultBytesValue
extends BytesValue

The bytes implementation. For convenience several methods are offered to get different representations of the entity and to ease the handling of bytes values in Mule flows. Bytes can be constructed from long, byte array as well as from strings as utf-8 bytes or hexadecimal representation. An bytes value object is immutable and comparable to other bytes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	value The BytesValue value

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultBytesValue(byte[] bytes) Constructs an BytesValue from a byte array value.
	DefaultBytesValue(DefaultBytesValue bytes) Constructs a BytesValue from a byte array value.
	DefaultBytesValue(int intValue) Constructs an bytes from a Integer value.
	DefaultBytesValue(long longValue) Constructs an bytes from a Long value.
	DefaultBytesValue(String string) Constructs an bytes from a string using UTF-8 encoding.
	DefaultBytesValue(String string, int radix) Constructs an bytes from string interpreted as number using given radix.
protected	DefaultBytesValue(String string, int min, int max) Constructs bytes from a string using UTF-8 encoding.

Method Summary

Modifier and Type	Method and Description
byte[]	getValue() Get the bytes value as byte array.
String	getValueAsHex() Get the bytes value as hexadecimal string.
long	getValueAsNumber() Get the bytes value as long.
String	getValueAsString() Get bytes value as UTF-8 string.
static DefaultBytesValue	valueOf(byte[] bytes) Static function that creates bytes from byte array.
static DefaultBytesValue	valueOf(int intValue) Static function that creates bytes from Integer.
static DefaultBytesValue	valueOf(long longValue) Static function that creates bytes from Long.
static DefaultBytesValue	valueOf(String string) Static function that creates bytes from string using utf-8 representation.
static DefaultBytesValue	valueOf(String string, int radix) Static function that creates bytes from string interpreted as number using given radix.

Methods inherited from class nl.teslanet.mule.connectors.coap.api.binary.BytesValue

compareTo, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

protected final byte[] value

The BytesValue value

Constructor Detail

DefaultBytesValue

public DefaultBytesValue(DefaultBytesValue bytes)

Constructs a BytesValue from a byte array value.

Parameters:

bytes - The bytes valuee

DefaultBytesValue

public DefaultBytesValue(byte[] bytes)

Constructs an BytesValue from a byte array value.

Parameters:

bytes - The byte array containing the BytesValue value

DefaultBytesValue

public DefaultBytesValue(String string)
                  throws OptionValueException

Constructs an bytes from a string using UTF-8 encoding.

Parameters:

string - contains the string representation of the bytes value.

Throws:

OptionValueException - when given string cannot be converted to bytes.

DefaultBytesValue

protected DefaultBytesValue(String string,
                            int min,
                            int max)
                     throws OptionValueException

Constructs bytes from a string using UTF-8 encoding.

Parameters:

string - contains the string representation of the bytes value.

Throws:

OptionValueException - when given string does not result in min..max bytes

DefaultBytesValue

public DefaultBytesValue(String string,
                         int radix)
                  throws OptionValueException

Constructs an bytes from string interpreted as number using given radix.

Parameters:

string - contains the string representation of the bytes value.

Throws:

OptionValueException - when given string does not represent a bytes length of 1..8 bytes

DefaultBytesValue

public DefaultBytesValue(int intValue)

Constructs an bytes from a Integer value.

Parameters:

intValue - The value to create an bytes from.

DefaultBytesValue

public DefaultBytesValue(long longValue)

Constructs an bytes from a Long value.

Parameters:

longValue - The value to create an bytes from.

Method Detail

getValue

public byte[] getValue()

Get the bytes value as byte array. Cf does clone the byte array also, however not cloning here would make the class mutable. This is considered acceptable because bytes are supposed to be small objects.

Overrides:

getValue in class BytesValue

Returns:

byte array containing the bytes value.

getValueAsNumber

public long getValueAsNumber()

Get the bytes value as long.

Overrides:

getValueAsNumber in class BytesValue

Returns:

Long containing the bytes value.

getValueAsString

public String getValueAsString()

Get bytes value as UTF-8 string.

Overrides:

getValueAsString in class BytesValue

Returns:

The UTF-8 string interpretation.

getValueAsHex

public String getValueAsHex()

Get the bytes value as hexadecimal string. Hexadecimal values a-f will be lower case.

Overrides:

getValueAsHex in class BytesValue

Returns:

The string containing the hexadecimal representation or empty string when bytes has no value.

valueOf

public static DefaultBytesValue valueOf(byte[] bytes)
                                 throws OptionValueException

Static function that creates bytes from byte array.

Parameters:

bytes - The byte array containing bytes value.

Returns:

The bytes object created.

Throws:

OptionValueException - when byte array was empty or too large.

valueOf

public static DefaultBytesValue valueOf(int intValue)
                                 throws OptionValueException

Static function that creates bytes from Integer.

Parameters:

intValue - The integer value to create bytes from.

Returns:

The bytes value created.

Throws:

OptionValueException - when byte array was empty or too large.

valueOf

public static DefaultBytesValue valueOf(long longValue)
                                 throws OptionValueException

Static function that creates bytes from Long.

Parameters:

longValue - The long value to create bytes from.

Returns:

The bytes object created.

Throws:

OptionValueException - When longValue <= 0.

valueOf

public static DefaultBytesValue valueOf(String string)
                                 throws OptionValueException

Static function that creates bytes from string using utf-8 representation.

Parameters:

string - the string to create bytes from.

Returns:

The bytes object created.

Throws:

OptionValueException - when given string was too large.

valueOf

public static DefaultBytesValue valueOf(String string,
                                        int radix)
                                 throws OptionValueException

Static function that creates bytes from string interpreted as number using given radix.

Parameters:

string - the string to create bytes from.

Returns:

The bytes object created.

Throws:

OptionValueException - when given string cannot be converted.