com.amazonaws.hal

Interface ResourceInfo

public interface ResourceInfo

An optional interface that a HAL resource interface can extend to expose additional details about the resource.

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	_getAvailableLinks() A HAL resource may have one or more links.
String	_getLinkHref(String relation) Get the href associated to the link with the specified relation.
Object	_getProperty(String propertyName) Properties of a HAL resource will normally be accessed by getter methods declared in an resource interface.
String	_getSelfHref() A HAL resource has at least a "self" link.
boolean	_isLinkAvailable(String relation) Test to see if the current resource contains a link with the specified relation.

Method Detail

_isLinkAvailable

boolean _isLinkAvailable(String relation)

Test to see if the current resource contains a link with the specified relation.

Parameters:

relation - the name of the relation to test for

Returns:

True if the link is present, false otherwise

_getAvailableLinks

Set<String> _getAvailableLinks()

A HAL resource may have one or more links. This method returns a set with the names of the link relations.

Returns:

A set of relation names for this resource.

_getProperty

Object _getProperty(String propertyName)

Properties of a HAL resource will normally be accessed by getter methods declared in an resource interface. This method can be used to get a property value that isn't exposed for some reason.

Parameters:

propertyName - the name of the property to get

Returns:

the value of the property, or null if it doesn't exist

_getSelfHref

String _getSelfHref()

A HAL resource has at least a "self" link. This method returns the href associated with this relation.

Returns:

the href value of the "self" link.

_getLinkHref

String _getLinkHref(String relation)

Get the href associated to the link with the specified relation.

Parameters:

relation - the name of the relation

Returns:

the href value of the specified relation