com.basho.riak.client.core.query.links

Class RiakLinks

java.lang.Object

com.basho.riak.client.core.query.links.RiakLinks

All Implemented Interfaces:

Iterable<RiakLink>

public class RiakLinks
extends Object
implements Iterable<RiakLink>

A thread safe container for RiakLink objects.

Since:

2.0

Author:

Brian Roach

See Also:

RiakLink

Thread Safety:

This is a thread safe container.

Constructor Summary

Constructors

Constructor and Description
RiakLinks()

Method Summary

Methods

Modifier and Type	Method and Description
RiakLinks	addLink(RiakLink link) Adds a RiakLink
RiakLinks	addLinks(Collection<RiakLink> links) Add RiakLinks
Set<RiakLink>	getLinks() Return all the links.
boolean	hasLink(RiakLink link) Determine if a specific RiakLink is present.
boolean	isEmpty() Reports if there are any RiakLink objects present
Iterator<RiakLink>	iterator() Return an iterator
void	removeAllLinks() Remove all links
boolean	removeLink(RiakLink link) Remove a RiakLink
int	size() Returns the number of links present

Methods inherited from class java.lang.Object

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

Constructor Detail

RiakLinks

public RiakLinks()

Method Detail

isEmpty

public boolean isEmpty()

Reports if there are any RiakLink objects present

Returns:

true if there are links present, false otherwise

size

public int size()

Returns the number of links present

Returns:

the number of links present

hasLink

public boolean hasLink(RiakLink link)

Determine if a specific RiakLink is present.

Parameters:

link - The RiakLink to check for.

Returns:

true if the link is present, false otherwise

addLinks

public RiakLinks addLinks(Collection<RiakLink> links)

Add RiakLinks

Parameters:

links - a Collection of RiakLink objects to add

Returns:

a reference to this object

addLink

public RiakLinks addLink(RiakLink link)

Adds a RiakLink

Parameters:

link - a RiakLink to be added

Returns:

a reference to this object

removeLink

public boolean removeLink(RiakLink link)

Remove a RiakLink

Parameters:

link - the RiakLink to remove

Returns:

true if the link was present and was removed, false otherwise

removeAllLinks

public void removeAllLinks()

Remove all links

getLinks

public Set<RiakLink> getLinks()

Return all the links.

Changes to the returned set do not modify this container.

Returns:

the set of RiakLink objects

iterator

public Iterator<RiakLink> iterator()

Return an iterator

Specified by:

iterator in interface Iterable<RiakLink>

Returns:

an Iterator that returns the links in this container