io.urf.surf

Class SurfObject

java.lang.Object

io.urf.surf.SurfObject

public class SurfObject
extends Object

A SURF object for a SURF document.

SURF objects are considered equal if their tags, type handles, IDs, and property handles and values are equal.

Author:

Garret Wilson

Constructor Summary

Constructors

Constructor and Description
SurfObject() Constructor of a object with no tag and an unknown type.
SurfObject(String typeHandle) Optional type handle constructor.
SurfObject(String typeHandle, String id) Type handle and optional ID constructor.
SurfObject(URI tag) Optional tag constructor.
SurfObject(URI tag, String typeHandle) Optional tag and optional type handle constructor.

Method Summary

Modifier and Type	Method and Description
void	clearProperties() Removes all properties.
boolean	equals(Object object)
Optional<String>	getId() Returns the ID, if any, of the object for its type.
Iterable<Map.Entry<String,Object>>	getProperties()
int	getPropertyCount()
Optional<Object>	getPropertyValue(String propertyHandle) Retrieves the value of a property by the property handle.
Optional<URI>	getTag()
Optional<String>	getTypeHandle()
boolean	hasDescription()
int	hashCode()
void	setProperties(Map<String,?> properties) Sets property values from a map of property handles and values.
Optional<Object>	setPropertyValue(String propertyHandle, Object value) Sets a property value by the property handle.

Methods inherited from class java.lang.Object

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

Constructor Detail

SurfObject

public SurfObject()

Constructor of a object with no tag and an unknown type.

SurfObject

public SurfObject(@Nullable
                  URI tag)

Optional tag constructor.

Parameters:

tag - The identifying object tag, or null if not known.

Throws:

IllegalArgumentException - if a tag is given that is not an absolute IRI.

SurfObject

public SurfObject(@Nullable
                  URI tag,
                  @Nullable
                  String typeHandle)

Optional tag and optional type handle constructor.

Parameters:

tag - The identifying object tag, or null if not known.

typeHandle - The handle of the object type, or null if not known.

Throws:

IllegalArgumentException - if a tag is given that is not an absolute URI.

IllegalArgumentException - if the given type handle is not a valid SURF handle.

SurfObject

public SurfObject(@Nullable
                  String typeHandle)

Optional type handle constructor.

Parameters:

typeHandle - The handle of the object type, or null if not known.

Throws:

IllegalArgumentException - if the given type handle is not a valid SURF handle.

SurfObject

public SurfObject(@Nonnull
                  String typeHandle,
                  @Nullable
                  String id)

Type handle and optional ID constructor.

Parameters:

typeHandle - The handle of the object type.

id - The object identifier unique for the object type.

Throws:

NullPointerException - if the given type handle is null.

IllegalArgumentException - if the given type handle is not a valid SURF handle.

Method Detail

getTag

public Optional<URI> getTag()

Returns:

The object identifier tag.

getTypeHandle

public Optional<String> getTypeHandle()

Returns:

The handle of the object type if known.

getId

public Optional<String> getId()

Returns the ID, if any, of the object for its type. Objects with no type never have an ID.

Returns:

The ID, if any, of the object.

getPropertyCount

public int getPropertyCount()

Returns:

The number of properties this object has.

hasDescription

public boolean hasDescription()

Returns:

true if this object has at least one property.

getPropertyValue

public Optional<Object> getPropertyValue(String propertyHandle)

Retrieves the value of a property by the property handle.

Parameters:

propertyHandle - The handle of the property.

Returns:

The value of the property, if any.

setPropertyValue

public Optional<Object> setPropertyValue(String propertyHandle,
                                         Object value)

Sets a property value by the property handle.

Parameters:

propertyHandle - The handle of the property.

value - The new value of the property.

Returns:

The previous value of the property, if any.

Throws:

IllegalArgumentException - if the given property handle does not conform to the rules for a SURF handle.

getProperties

public Iterable<Map.Entry<String,Object>> getProperties()

Returns:

An iterable to the object's properties by handle and their associated values.

clearProperties

public void clearProperties()

Removes all properties.

setProperties

public void setProperties(@Nonnull
                          Map<String,?> properties)

Sets property values from a map of property handles and values. Neither null property handles nor null property values are allowed.

Parameters:

properties - The map of property handles and values.

Throws:

NullPointerException - if one or more of the given property handles or values is null.

IllegalArgumentException - if one of the given property handles does not conform to the rules for a SURF handle.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object