Package ca.phon.phonex

Annotation Interface PhonexPlugin

@Target(TYPE)
@Retention(RUNTIME)
@Documented
public @interface PhonexPlugin

Annotation required for phonex plug-ins. Identifies the name used for matcher part of the phonex expression.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	name	The name used in the phonex expression to identify the matcher.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	arguments	List of argument names
String	description	Description of plug-in

Element Details

name

String name

The name used in the phonex expression to identify the matcher.

For example, if the a class FooMatcher implements PluginProvider and has the annotation @PhonexPlugin(name="foo") then FooMatcher will be used to parse phonex matchers identified with the "foo" string.

 {}:foo(<expression>)
 

The value of expression will be passed into the

invalid @link

PluginProvider#checkInput(String)

and

invalid @link

PluginProvider#createMatcher(String)

methods.

description

String description

Description of plug-in

Default:

""

arguments

String[] arguments

List of argument names

Default:

{}