com.basho.riak.client.raw.query
Class LinkWalkSpec

java.lang.Object
  com.basho.riak.client.raw.query.LinkWalkSpec

All Implemented Interfaces:

Iterable<LinkWalkStep>

public class LinkWalkSpec
extends Object
implements Iterable<LinkWalkStep>

An immutable class that represents a link walk specification, built by a LinkWalk operation, used internally.

There is no need to create an instance of this class. The LinkWalk operation (obtained from IRiakClient.walk(com.basho.riak.client.IRiakObject))is the correct way to generate and submit a LinkWalk spec.

Author:

russell

See Also:

IRiakClient.walk(com.basho.riak.client.IRiakObject), LinkWalk.execute()

Constructor Summary

LinkWalkSpec(LinkedList<LinkWalkStep> steps, String startBucket, String startKey)
Create the link walk spec.

Method Summary

String	getStartBucket() The bucket of the object to walk from.
String	getStartKey() The key of the object to walk from.
Iterator<LinkWalkStep>	iterator()
int	size() How many steps in this link walk spec?

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkWalkSpec

public LinkWalkSpec(LinkedList<LinkWalkStep> steps,
                    String startBucket,
                    String startKey)

Create the link walk spec.

Parameters:

steps -

startBucket -

startKey -

See Also:

LinkWalk.execute(), IRiakClient.walk(com.basho.riak.client.IRiakObject)

Method Detail

getStartBucket

public String getStartBucket()

The bucket of the object to walk from.

Returns:

the startBucket

getStartKey

public String getStartKey()

The key of the object to walk from.

Returns:

the startKey

iterator

public Iterator<LinkWalkStep> iterator()

Specified by:

iterator in interface Iterable<LinkWalkStep>

size

public int size()

How many steps in this link walk spec?

Returns:

how many steps in this link spec