com.kapowtech.robosuite.api.java.rql.construct

Class Attribute

java.lang.Object

com.kapowtech.robosuite.api.java.rql.construct.Attribute

All Implemented Interfaces:

java.util.Map.Entry<java.lang.String,java.lang.Object>

public final class Attribute
extends java.lang.Object
implements java.util.Map.Entry<java.lang.String,java.lang.Object>

Represents an attribute as an entry in an ExtractedObject or a QueryParameter.

Attribute is an Map.Entry implementation used in the Map returned by ExtractedObject.getAttributes().

See Also:

AttributeType

Constructor Summary

Constructors

Constructor and Description
Attribute(java.lang.String name, AttributeType type) Creates a new Attribute representing an attribute with the value null in an object model.
Attribute(java.lang.String name, java.lang.Object value) Creates a new Attribute representing an attribute in an object model.
Attribute(java.lang.String name, java.lang.String value, AttributeType type) Creates a new Attribute representing an attribute in an object model.
Attribute(java.lang.String name, java.lang.String value, java.lang.String type) Creates a new Attribute representing an attribute in an object model.

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	coerceToAcceptedValue(java.lang.Object value) Coerces a value into a value accepted by the API.
boolean	equals(java.lang.Object o) Compares the specified object with this entry for equality.
java.lang.String	getKey() Returns the name of the attribute that is used as a key for this entry.
java.lang.String	getName() Returns the name of the attribute that is used as a key for this entry.
AttributeType	getType() Returns the type of the attribute.
java.lang.Object	getValue() Returns the attribute value corresponding to this entry.
int	hashCode() Returns the hash code value for this map entry.
java.lang.Object	setValue(java.lang.Object value) This operation is not supported by this class, always throwing an UnsupportedOperationException.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue

Constructor Detail

Attribute

public Attribute(java.lang.String name,
                 java.lang.Object value)

Creates a new Attribute representing an attribute in an object model.

If the value parameter is null, its type will default to AttributeType.TEXT.

Parameters:

name - the attribute name

value - the attribute value, which must be a valid type. The attribute types are restricted to: java.lang.Boolean, java.util.Date, java.lang.Double, java.lang.Long, java.lang.Character, java.lang.String, and com.kapowtech.robosuite.api.java.rql.construct.Binary

Throws:

java.lang.NullPointerException - if name is null.

java.lang.IllegalArgumentException - if the value parameter is not an allowed type.

Attribute

public Attribute(java.lang.String name,
                 java.lang.String value,
                 AttributeType type)

Creates a new Attribute representing an attribute in an object model.

Parameters:

name - the attribute name

value - the attribute value as a string

type - the type of the attribute, which will be used to parseAttributeType the value parameter.

Throws:

java.lang.NullPointerException - if name is null.

java.lang.IllegalArgumentException - if the value parameter could not be parsed to the type specified by the type parameter.

Attribute

public Attribute(java.lang.String name,
                 AttributeType type)

Creates a new Attribute representing an attribute with the value null in an object model.

Parameters:

name - the attribute name

type - the type of the attribute, which will be used to parseAttributeType the value parameter.

Throws:

java.lang.NullPointerException - if name is null.

java.lang.IllegalArgumentException - if the value parameter could not be parsed to the type specified by the type parameter.

Attribute

public Attribute(java.lang.String name,
                 java.lang.String value,
                 java.lang.String type)

Creates a new Attribute representing an attribute in an object model.

Parameters:

name - the attribute name

value - the attribute value as a string

type - the type name of the attribute, which will be used to parseAttributeType the value parameter.

Throws:

java.lang.NullPointerException - if name is null.

java.lang.IllegalArgumentException - if the value parameter is not an allowed type.

Method Detail

coerceToAcceptedValue

public static java.lang.Object coerceToAcceptedValue(java.lang.Object value)

Coerces a value into a value accepted by the API.

The following coercions are done:

• byte[] is wrapped in a Binary object.
• java.lang.Integer is promoted to java.lang.Long.
• java.lang.Short is promoted to java.lang.Long.
• java.lang.Byte is promoted to java.lang.Long.
• java.math.BigInteger is narrowed to java.lang.Long.
• java.lang.Float is promoted to java.lang.Double.
• java.math.BigDecimal is narrowed to java.lang.Double.

If the value is not one of these type, it will not be altered by this method.

Parameters:

value - the value to coerce.

Returns:

the coerced value.

getKey

public java.lang.String getKey()

Returns the name of the attribute that is used as a key for this entry.

Specified by:

getKey in interface java.util.Map.Entry<java.lang.String,java.lang.Object>

Returns:

the name of the attribute that is used as a key for this entry. This object is of type String and is never null.

See Also:

getName()

getName

public java.lang.String getName()

Returns the name of the attribute that is used as a key for this entry. This has the same effect as calling getKey, except the name attribute is returned as a String.

Returns:

the name of the attribute that is used as a key for this entry.

See Also:

getKey()

getType

public AttributeType getType()

Returns the type of the attribute.

Returns:

the type of the attribute.

getValue

public java.lang.Object getValue()

Returns the attribute value corresponding to this entry.

Specified by:

getValue in interface java.util.Map.Entry<java.lang.String,java.lang.Object>

Returns:

the attribute value corresponding to this entry.

setValue

public java.lang.Object setValue(java.lang.Object value)

This operation is not supported by this class, always throwing an UnsupportedOperationException.

Specified by:

setValue in interface java.util.Map.Entry<java.lang.String,java.lang.Object>

Parameters:

value - new value to be stored in this entry. (ignored)

Returns:

n/a - always throws an exception

Throws:

java.lang.UnsupportedOperationException - if the put operation is not supported by the backing map.

equals

public boolean equals(java.lang.Object o)

Compares the specified object with this entry for equality. Returns true if the given object is also a map entry and the two entries represent the same mapping.

This implementation obeys the general contract specified in Map.Entry.

Specified by:

equals in interface java.util.Map.Entry<java.lang.String,java.lang.Object>

Overrides:

equals in class java.lang.Object

Parameters:

o - object to be compared for equality with this map entry.

Returns:

true if the specified object is equal to this map entry.

See Also:

Map.Entry.equals

hashCode

public int hashCode()

Returns the hash code value for this map entry. This implementation follows the general contract specified in Map.Entry.

Specified by:

hashCode in interface java.util.Map.Entry<java.lang.String,java.lang.Object>

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value for this map entry.

See Also:

Map.Entry.hashCode

toString

public java.lang.String toString()

Returns a string representation of the object. It will be a string of the form: getName() + '=' + getValue().

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object