com.basho.riak.client.core.query.functions

Class Function

java.lang.Object

com.basho.riak.client.core.query.functions.Function

public class Function
extends Object

A Function for use with bucket properties or asMap reduce. Instances are created via the provided static factory methods or by using the Builder.

Since:

2.0

Author:

Brian Roach

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Function.Builder Builder class for creating Function instances.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBucket() Returns the bucket for this stored JS function.
String	getFunction() Returns the function for this Erlang function.
String	getKey() Returns the key for this stored JS function.
String	getModule() Returns the module for this Erlang function.
String	getName() Returns the name of this named JS function.
String	getSource() Returns the source for this anonymous JS function.
int	hashCode()
boolean	isAnonymous() Return whether this is an anonymous JS function or not.
boolean	isJavascript() Returns whether this function is Javascript or not.
boolean	isNamed() Return whether this is a named JS function or not.
boolean	isStored() Return whether this is a JS function stored as an object in Riak.
static Function	newAnonymousJsFunction(String source) Static factory method for Anonymous JS Functions.
static Function	newErlangFunction(String module, String function) Static factory method for Erlang Functions.
static Function	newNamedJsFunction(String name) Static factory method for Named Javascript Functions.
static Function	newStoredJsFunction(String bucket, String key) Static factory method for Stored Javascript Functions.

Methods inherited from class java.lang.Object

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

Method Detail

isJavascript

public boolean isJavascript()

Returns whether this function is Javascript or not.

Returns:

true if this is a JS function, false if Erlang.

isNamed

public boolean isNamed()

Return whether this is a named JS function or not.

Returns:

true if this is a named JS function, false otherwise.

isStored

public boolean isStored()

Return whether this is a JS function stored as an object in Riak.

Returns:

true if this is a stored JS function, false otherwise.

isAnonymous

public boolean isAnonymous()

Return whether this is an anonymous JS function or not.

Returns:

true if this is an anonymous JS function, false otherwise.

getName

public String getName()

Returns the name of this named JS function.

Returns:

The name for this function or null if this is not a named JS function.

getBucket

public String getBucket()

Returns the bucket for this stored JS function.

Returns:

The bucket for this function or null if this is not a stored JS function.

getKey

public String getKey()

Returns the key for this stored JS function.

Returns:

The key for function or null is this is not a stored JS function.

getSource

public String getSource()

Returns the source for this anonymous JS function.

Returns:

The source for this function, or null if it is not an anonymous function.

getModule

public String getModule()

Returns the module for this Erlang function.

Returns:

the module for this function or null if this is not an Erlang function.

getFunction

public String getFunction()

Returns the function for this Erlang function.

Returns:

the function or null if this is not an erlang function.

newNamedJsFunction

public static Function newNamedJsFunction(String name)

Static factory method for Named Javascript Functions.

Parameters:

name - the name of the Javascript function.

Returns:

a Function representing a named JS Function.

newStoredJsFunction

public static Function newStoredJsFunction(String bucket,
                           String key)

Static factory method for Stored Javascript Functions.

Parameters:

bucket - The bucket where the JS function is stored

key - the key for the object containing the JS function

Returns:

a Function representing a stored JS function.

newAnonymousJsFunction

public static Function newAnonymousJsFunction(String source)

Static factory method for Anonymous JS Functions.

Parameters:

source - the javascript source

Returns:

a Function representing an anonymous JS function.

newErlangFunction

public static Function newErlangFunction(String module,
                         String function)

Static factory method for Erlang Functions.

Parameters:

module - the module that contains the Erlang function.

function - the name of the erlang function.

Returns:

a Function representing a Erlang function.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object