Hint Interface Reference

List of all members.


Detailed Description

Each method of an interface which extends DataObject should be annotated with a Hint, if it is a value which should be included when the object is serialized to XML.

Author:
sschwieb

Public Methods

Display display () default Display.UNDEFINED
String name () default UNDEFINED
String[] defaults () default

Public Static Fields

static final String UNDEFINED = "UNDEFINED"

Method Details

String [] defaults ( )

If a method which should be exported requires parameters, this array can be used to set useful default values. Note: Only primitive values and Strings can be referred this way. null is a legal value for Strings only. This features has not been tested well yet!

See also:
IReplacement.getReplacements(boolean) IReplacement.getReplacements(boolean) for an example.
Returns:
Display display ( )

Recommended display mode, default is Display#UNDEFINED

Returns:
String name ( )

The human readable name of the method, as it will be displayed when a user selects fields in the export wizard, and as it will be inserted into the generated XML data.

Returns:

Field Details

final String UNDEFINED = "UNDEFINED" [static]