org.ektorp.support

Annotation Type ListFunction

@Target(value={METHOD,TYPE})
@Retention(value=RUNTIME)
public @interface ListFunction

Annotation for defining list functions embedded in repositories.

Author:

henrik lundgren

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of the list function

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	file List functions are best stored in a separate files.
String	function Inline list function.

Element Detail

name

public abstract String name

The name of the list function

Returns:

function

public abstract String function

Inline list function.

Returns:

Default:

""

file

public abstract String file

List functions are best stored in a separate files. By specifying the file parameter a function can be loaded from the classpath. The path is relative to the class annotated by this annotation. If the file my_list_func.json is in the same directory as the repository this parameter should be set to "my_list_func.js".

Returns:

Default:

""