com.rli.util.identityData

Class ComplexValue

java.lang.Object

com.rli.util.identityData.ComplexValue

All Implemented Interfaces:

java.lang.Cloneable

public class ComplexValue
extends java.lang.Object
implements java.lang.Cloneable

A complex value represents a value that is itself composed of a set of attributes and values. For example, a complex value for a "name" attribute could be: { "first":"John", "middle":"Patrick", "last": Smith }.

Constructor Summary

Constructors

Constructor and Description
ComplexValue()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String attributeName, java.util.List<java.lang.String> values) Sets one or more values for the specified attribute of this complex value.
void	add(java.lang.String attributeName, java.lang.String value) Sets a single value for the specified attribute of this complex value.
java.lang.Object	clone()
boolean	containsAttribute(java.lang.String attributeName) Indicates whether this ComplexValue contains the specified attribute.
com.fasterxml.jackson.databind.JsonNode	get(java.lang.String attributeName) Returns the value(s) for the specified attribute in the format of a com.fasterxml.jackson.databind.JsonNode object, or null if the attribute does not exist.
java.util.Set<java.lang.String>	getAttributeNames() Returns the set of all attribute names for this ComplexValue.
java.lang.String	getFirstValueAsString(java.lang.String attributeName) Returns the first value in the list of values for the specified attribute, or null if the attribute does not exist.
java.util.List<java.lang.String>	getValuesAsString(java.lang.String attributeName) Returns the list of values for the specified attribute, or null if the attribute does not exist.
void	remove(java.lang.String attributeName) Removes the specified attribute and its associated values from this ComplexValue.
void	setAdditionalProperty(java.lang.String name, java.lang.Object value) This method is reserved for internal use.
java.lang.String	toJSONString() Returns a String containing the JSON representation of this object.
java.lang.String	toString() Returns the String representation of this object.
ComplexValue	withAttribute(java.lang.String attributeName, java.util.List<java.lang.String> values) Returns an instance of the current ComplexValue object with the specified attribute set to the specified values.
ComplexValue	withAttribute(java.lang.String attributeName, java.lang.String value) Returns an instance of the current ComplexValue object with the specified attribute set to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplexValue

public ComplexValue()

Method Detail

setAdditionalProperty

public void setAdditionalProperty(java.lang.String name,
                                  java.lang.Object value)

This method is reserved for internal use.

Parameters:

name - The name of an attribute.

value - The value to set for the attribute.

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

add

public void add(java.lang.String attributeName,
                java.lang.String value)

Sets a single value for the specified attribute of this complex value. Note: this method will remove any values that have previously been set for the attribute and replace them with the specified value.

Parameters:

attributeName - The name of the attribute.

value - The value to set for the attribute.

add

public void add(java.lang.String attributeName,
                java.util.List<java.lang.String> values)

Sets one or more values for the specified attribute of this complex value. Note: this method will remove any values that have previously been set for the attribute and replace them with the specified values.

Parameters:

attributeName - The name of the attribute.

values - The values to set for the attribute.

withAttribute

public ComplexValue withAttribute(java.lang.String attributeName,
                                  java.lang.String value)

Returns an instance of the current ComplexValue object with the specified attribute set to the specified value. This method is intended to be used as a builder to easily set attributes on a ComplexValue object.

Example: ComplexValue cv = new ComplexValue().withAttribute("city", "Novato").withAttribute("name", "Radiant Logic");

Parameters:

attributeName - The name of an attribute.

value - The value to set for the attribute.

Returns:

An instance of the current ComplexValue object with the specified attribute set to the specified value.

withAttribute

public ComplexValue withAttribute(java.lang.String attributeName,
                                  java.util.List<java.lang.String> values)

Returns an instance of the current ComplexValue object with the specified attribute set to the specified values. This method is intended to be used as a builder to easily set attributes on a ComplexValue object.

Example: ComplexValue cv = new ComplexValue().withAttribute("city", Arrays.asList("Novato", "Chicago")) .withAttribute("name", "Radiant Logic");

Parameters:

attributeName - The name of an attribute.

values - The values to set for the attribute.

Returns:

An instance of the current ComplexValue object with the specified attribute set to the specified values.

remove

public void remove(java.lang.String attributeName)

Removes the specified attribute and its associated values from this ComplexValue.

Parameters:

attributeName - The attribute to remove.

containsAttribute

public boolean containsAttribute(java.lang.String attributeName)

Indicates whether this ComplexValue contains the specified attribute.

Parameters:

attributeName - The name of the attribute.

Returns:

true if this ComplexValue contains the specified attribute, or false otherwise.

getAttributeNames

public java.util.Set<java.lang.String> getAttributeNames()

Returns the set of all attribute names for this ComplexValue.

Returns:

the set of all attribute names for this ComplexValue.

getFirstValueAsString

public java.lang.String getFirstValueAsString(java.lang.String attributeName)

Returns the first value in the list of values for the specified attribute, or null if the attribute does not exist.

Parameters:

attributeName - The name of the attribute.

Returns:

the first value in the list of values for the specified attribute, or null if the attribute does not exist.

getValuesAsString

public java.util.List<java.lang.String> getValuesAsString(java.lang.String attributeName)

Returns the list of values for the specified attribute, or null if the attribute does not exist.

Parameters:

attributeName - The name of the attribute.

Returns:

the list of values for the specified attribute, or null if the attribute does not exist.

get

public com.fasterxml.jackson.databind.JsonNode get(java.lang.String attributeName)

Returns the value(s) for the specified attribute in the format of a com.fasterxml.jackson.databind.JsonNode object, or null if the attribute does not exist.

Parameters:

attributeName - The name of an attribute.

Returns:

the value(s) for the specified attribute in the format of a com.fasterxml.jackson.databind.JsonNode object, or null if the attribute does not exist.

toJSONString

public java.lang.String toJSONString()

Returns a String containing the JSON representation of this object.

Returns:

a String containing the JSON representation of this object.

toString

public java.lang.String toString()

Returns the String representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

the String representation of this object.