org.openimaj.demos

Annotation Type Demo

@Retention(value=RUNTIME)
public @interface Demo

An annotation for types that are implementing an OpenIMAJ demo. Use this annotation to specify that your class should be considered an OpenIMAJ demo. The Demos GUI will look for types that are annotated with this annotation for presenting to the user as a self-contained demo.

It is quite important that any classes that are annotated with this type are fully self-contained and do not have hard-coded, local filenames. They should use resources and the resources should be included.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

2 November 2011

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	author Name of the author of the demo
String	description A description of the demo.
String[]	keywords Keywords associated with the demo.
String	title The title of the demo.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	arguments Any arguments that need to be passed to the demo
String	icon The resource URI of an icon to represent the demo [optional]
String	screenshot The resource URI of a screenshot of the demo [optional]
String[]	vmArguments Any JVM arguments that need to be passed to the demo

Element Detail

title

public abstract String title

The title of the demo. Should be short. No more than 30 characters

author

public abstract String author

Name of the author of the demo

description

public abstract String description

A description of the demo. As long as you like.

keywords

public abstract String[] keywords

Keywords associated with the demo.

icon

public abstract String icon

The resource URI of an icon to represent the demo [optional]

Default:

"/defaults/demo.png"

screenshot

public abstract String screenshot

The resource URI of a screenshot of the demo [optional]

Default:

"/defaults/screenshot.png"

arguments

public abstract String[] arguments

Any arguments that need to be passed to the demo

Default:

{}

vmArguments

public abstract String[] vmArguments

Any JVM arguments that need to be passed to the demo

Default:

{}