org.jtransfo

Annotation Type MapOnly

@Retention(value=RUNTIME)
 @Target(value=FIELD)
 @Documented
public @interface MapOnly

Annotation which allows security filtering on jTransfo field behaviour. If a field has a MapOnly or MapOnlies annotation then the field will only be copied when one of the tags in the MapOnly or MapOnlies annotation is present. In that case the MappedBy annotation on the field will only be used to provide defaults for field/path or type converter.

By default fields are mapped in both directions between fields of the same name.

Field Summary

Fields

Modifier and Type	Fields and Description
static String	ALWAYS Tag which can be used to assure it is always called (handled before the specific cases).

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	value Tags for which this annotation applies.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	field Name of the field in the domain class.
String	path Path to the field when it is transitive.
boolean	readOnly When set, the field will not be written in the domain class when the tag is present.
String	typeConverter Fully qualified class name for the type converter.
Class	typeConverterClass Class to use for type conversion.

Field Detail

ALWAYS

public static final String ALWAYS

Tag which can be used to assure it is always called (handled before the specific cases).

Element Detail

value

public abstract String[] value

Tags for which this annotation applies.

field

public abstract String field

Name of the field in the domain class.

By default the field is assumed to have the same name in the domain class.

Default:

"?"

path

public abstract String path

Path to the field when it is transitive.

By default the path is empty, meaning that the field is inside the domain object itself.

Default:

""

readOnly

public abstract boolean readOnly

When set, the field will not be written in the domain class when the tag is present.

Default:

false

typeConverter

public abstract String typeConverter

Fully qualified class name for the type converter.

Using this allows you to override the type converter on the MappedBy annotation.

Default:

"?"

typeConverterClass

public abstract Class typeConverterClass

Class to use for type conversion.

Using this allows you to override the type converter on the MappedBy annotation.

This requires a compile dependency on the domain class. The value has precedence over typeConverter().

Default:

org.jtransfo.MappedBy.DefaultTypeConverter.class