nl.teslanet.mule.connectors.coap.api.options

Class OtherOptionAttribute

java.lang.Object

nl.teslanet.mule.connectors.coap.api.options.OtherOptionAttribute

Direct Known Subclasses:

CoapOtherOptionAttributeImpl

public class OtherOptionAttribute
extends Object

Other option attribute. This class is actually an interface but Mule needs a concrete class.

Constructor Summary

Constructors

Constructor and Description
OtherOptionAttribute()

Method Summary

Modifier and Type	Method and Description
String	getAlias() Get the alias of this other option.
OptionFormat	getFormat() Get the format of this other option.
int	getLength() Get the the length of the other option.
int	getNumber() Get the number of this other option.
InputStream	getValue() Get the value of this other option.
String	getValueAsHex() Get the option value as hexadecimal string.
long	getValueAsNumber() Get the value as number.
String	getValueAsString() Get value as UTF-8 string.
boolean	isCritical() Checks if option is critical.
boolean	isEmpty() Check if the option is empty.
boolean	isNoCacheKey() Checks if option with this number is a NoCacheKey option.
boolean	isUnsafe() Checks if option with this number is unsafe.

Methods inherited from class java.lang.Object

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

Constructor Detail

OtherOptionAttribute

public OtherOptionAttribute()

Method Detail

getAlias

public String getAlias()

Get the alias of this other option.

Returns:

The option number.

getNumber

public int getNumber()

Get the number of this other option.

Returns:

The option number.

getFormat

public OptionFormat getFormat()

Get the format of this other option.

Returns:

The option type.

getLength

public int getLength()

Get the the length of the other option.

Returns:

The number of bytes of this option.

getValue

public InputStream getValue()

Get the value of this other option.

Returns:

The option value if any, otherwise null.

getValueAsNumber

public long getValueAsNumber()

Get the value as number.

Returns:

long containing the value.

getValueAsHex

public String getValueAsHex()

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

Returns:

The string containing the hexadecimal representation or empty string when the value is empty.

getValueAsString

public String getValueAsString()

Get value as UTF-8 string.

Returns:

The UTF-8 string interpretation.

isCritical

public boolean isCritical()

Checks if option is critical.

Returns:

true if is option critical, otherwise false.

isUnsafe

public boolean isUnsafe()

Checks if option with this number is unsafe.

Returns:

true if this is an unsafe option, otherwise false.

isNoCacheKey

public boolean isNoCacheKey()

Checks if option with this number is a NoCacheKey option.

Returns:

true if this is NoCacheKey option, otherwise false.

isEmpty

public boolean isEmpty()

Check if the option is empty.

Returns:

True when the option is empty, otherwise false.