de.richtercloud.reflection.form.builder

Annotation Type ClassInfo

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface ClassInfo

Allows storage of information of classes (an official or displayable name which is useful if the class is named following a convention which produces ugly names and a description) which are displayed in the ReflectionFormPanel.

Author:

richter

See Also:

FieldInfo

Field Summary

Fields

Modifier and Type	Fields and Description
static String	DESCRIPTION_DEFAULT

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A field describing the function of the field in the entity or embeddable and eventually explaining design decisions.
String	iconResourcePath A path to a resource which represents an Icon which can be used in components which display details of the class.
String	name Override field name to appear more natural or better explaining the structure of the data (e.g.

Field Detail

DESCRIPTION_DEFAULT

public static final String DESCRIPTION_DEFAULT

Element Detail

name

public abstract String name

Override field name to appear more natural or better explaining the structure of the data (e.g. Finance accounts might appear much more clear than accounts. "" indicates that the field name ought to be used (because null can't be specified).

Returns:

the field name or the empty string

Default:

""

description

public abstract String description

A field describing the function of the field in the entity or embeddable and eventually explaining design decisions.

Returns:

Default:

""

iconResourcePath

public abstract String iconResourcePath

A path to a resource which represents an Icon which can be used in components which display details of the class.

Returns:

a resource path with can be used to retrieve a URL with ClassLoader.getResource(java.lang.String)

Default:

""