pl.bristleback.server.bristle.token
Annotation Type Tokenize

@Target(value=FIELD)
@Retention(value=RUNTIME)
public @interface Tokenize

Description of adding parameters to token operation. Marks Tokenizer fields. Describes names of added parameters and optionally: tokenizer class, deep search of value fields and name of parameter set. To have multiple Tokenize annotations above one tokenizer field, see TokenizeSet annotation.

Created on: 2010-12-16 14:24:44

Author:

Wojciech Niemiec

Required Element Summary

java.lang.String[]

parameters Names of parameters under which values will passed to token.

Optional Element Summary

boolean	deepSearch Indicates whether deep search of value fields should be performed.
java.lang.Class<? extends TokenizerEngine>	engine Points what tokenizer engine implementation should be used to pass values to token.
java.lang.String	name Name of this parameter passing operation.

Element Detail

parameters

public abstract java.lang.String[] parameters

Names of parameters under which values will passed to token. Required.

Returns:

names of parameters.

deepSearch

public abstract boolean deepSearch

Indicates whether deep search of value fields should be performed. Default false.

Returns:

true if deep search of value fields should be performed, false otherwise.

Default:

false

engine

public abstract java.lang.Class<? extends TokenizerEngine> engine

Points what tokenizer engine implementation should be used to pass values to token. Default JsonTokenizerEngine is used.

Returns:

object tokenizer implementation used to pass values to token.

Default:

pl.bristleback.server.bristle.token.TokenizerEngine.class

name

public abstract java.lang.String name

Name of this parameter passing operation. Default value is empty. If there are multiple Tokenize annotations with the same number of parameters, they must provide unique name to identify them. To add named values (parameter name of this annotation is not empty), invoke Tokenizer.tokenizeNamed(org.jwebsocket.token.Token, java.lang.String, java.lang.Object...) method.

Returns:

name of this parameter passing operation

Default:

""