siren

Class Link

java.lang.Object

siren.Link

public class Link
extends java.lang.Object

Represent navigational transitions.

Since:

8/13/17

Author:

jonfreer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Link.Builder Constructs instances of Link.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determines if the instance of Object provided is equal to the calling Link instance.
java.net.URI	getHref() Retrieves the URI of the linked resource.
java.util.List<java.lang.String>	getKlass() Retrieves the class for the link.
java.util.List<Relation>	getRel() Retrieves the relationship of the link to its entity.
java.lang.String	getTitle() Retrieves the title of the link.
java.lang.String	getType() Retrieves the link's type.
int	hashCode() Generates hashcode represented as an integer for the calling Link instance.

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(java.lang.Object obj)

Determines if the instance of Object provided is equal to the calling Link instance.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The instance of Link being examined.

Returns:

true if the instances are equal; false otherwise.

hashCode

public int hashCode()

Generates hashcode represented as an integer for the calling Link instance.

Overrides:

hashCode in class java.lang.Object

Returns:

The hashcode for the calling Link instance.

getRel

public java.util.List<Relation> getRel()

Retrieves the relationship of the link to its entity.

Returns:

The relationship of the link to its entity, per Web Linking (RFC5988) and Link Relations.

See Also:

RFC5988, Link Relations

getKlass

public java.util.List<java.lang.String> getKlass()

Retrieves the class for the link.

Returns:

List of strings describing aspects of the link based on the current representation. Possible values are implementation-dependent and should be documented.

getTitle

public java.lang.String getTitle()

Retrieves the title of the link.

Returns:

String describing the nature of a link.

getType

public java.lang.String getType()

Retrieves the link's type.

Returns:

The media type of the linked resource, per Web Linking (RFC5988). For the syntax, see RFC2045 (section 5.1), RFC4288 (section 4.2), RFC6838 (section 4.2).

See Also:

RFC5988, RFC2045, RFC4288, RFC6838

getHref

public java.net.URI getHref()

Retrieves the URI of the linked resource.

Returns:

The URI of the linked resource.