com.github.jasminb.jsonapi

Class Links

java.lang.Object

com.github.jasminb.jsonapi.Links

All Implemented Interfaces:

Serializable

public class Links
extends Object
implements Serializable

JSON API spec links object.

Author:

jbegic

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Links() Create new Links.
Links(Map<String,Link> linkMap) Create new Links.

Method Summary

Modifier and Type	Method and Description
void	addLink(String linkName, Link link) Adds a named link.
Link	getFirst() Convenience method for returning the first link.
Link	getLast() Convenience method for returning the last link.
Link	getLink(String linkName) Convenience method for returning named link.
Map<String,Link>	getLinks() Gets all registered links.
Link	getNext() Convenience method for returning the next link.
Link	getPrevious() Convenience method for returning the prev link.
Link	getRelated() Convenience method for returning the related link.
Link	getSelf() Convenience method for returning the self link.

Methods inherited from class java.lang.Object

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

Constructor Detail

Links

public Links()

Create new Links.

Links

public Links(Map<String,Link> linkMap)

Create new Links.

Parameters:

linkMap - Map link data

Method Detail

getLink

public Link getLink(String linkName)

Convenience method for returning named link.

Parameters:

linkName - name of the link to return

Returns:

the link object, or null if the named link does not exist

getPrevious

public Link getPrevious()

Convenience method for returning the prev link.

Returns:

the link, or null if the named link does not exist

getFirst

public Link getFirst()

Convenience method for returning the first link.

Returns:

the link, or null if the named link does not exist

getNext

public Link getNext()

Convenience method for returning the next link.

Returns:

the link, or null if the named link does not exist

getLast

public Link getLast()

Convenience method for returning the last link.

Returns:

the link, or null if the named link does not exist

getSelf

public Link getSelf()

Convenience method for returning the self link.

Returns:

the link, or null if the named link does not exist

getRelated

public Link getRelated()

Convenience method for returning the related link.

Returns:

the link, or null if the named link does not exist

getLinks

public Map<String,Link> getLinks()

Gets all registered links.

Returns:

Map link data

addLink

public void addLink(String linkName,
                    Link link)

Adds a named link.

Parameters:

linkName - name of the link to add

link - the link to add