Package org.apache.juneau.marshall

Annotation Interface MarshalledConfig

@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Inherited
@ContextApply(Applier.class)
public @interface MarshalledConfig

Annotation for specifying marshalling-only config properties defined in MarshallingContext and MarshallingTraverseContext.

Used primarily for specifying marshalling configuration properties on REST classes and methods.

This annotation is the marshalling-only sibling of @BeanConfig. Bean-modeling attributes (visibility settings, fluent-setter detection, property naming, not-bean exclusions, etc.) live on @BeanConfig in juneau-commons. Attributes that affect wire format, type discriminators, swap classes, locale/media-type/timezone, and debug mode stay here on @MarshalledConfig.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
BigNumberFormat	bigNumberFormat	Big-number wire format for BigInteger / BigDecimal values.
BinaryFormat	binaryFormat	Binary wire format for byte[] values.
BitSetFormat	bitSetFormat	BitSet wire format.
BooleanFormat	booleanFormat	Boolean wire format for Boolean / boolean values.
CalendarFormat	calendarFormat	Calendar wire format.
ClassFormat	classFormat	Class wire format for Class values.
CurrencyFormat	currencyFormat	Currency wire format for Currency values.
DateFormat	dateFormat	Date wire format.
String	debug	Debug mode.
Class<?>[]	dictionary	Bean dictionary.
Class<?>[]	dictionary_replace	Replace bean dictionary.
DurationFormat	durationFormat	Duration wire format.
EnumFormat	enumFormat	Enum wire format.
FloatFormat	floatFormat	Float / Double non-finite wire format for Float / Double values.
String	locale	Locale.
LocaleFormat	localeFormat	Locale wire format.
String	mediaType	Media type.
PeriodFormat	periodFormat	Period wire format.
int	rank	Optional rank for this config.
Class<?>[]	swaps	Java object swaps.
Class<?>[]	swaps_replace	Replace Java object swap classes.
TemporalFormat	temporalFormat	Temporal wire format.
String	timeZone	Time zone.
TimeZoneFormat	timeZoneFormat	Time-zone wire format.
String	typePropertyName	Bean type property name.
UuidFormat	uuidFormat	UUID wire format.

Element Details

debug

String debug

Debug mode.

Enables the following additional information during serialization:

• When bean getters throws exceptions, the exception includes the object stack information in order to determine how that method was invoked.
• Enables MarshallingTraverseContext.Builder.detectRecursions().

Enables the following additional information during parsing:

• When bean setters throws exceptions, the exception includes the object stack information in order to determine how that method was invoked.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• Context.Builder.debug()

Returns:

The annotation value.

Default:

""

dictionary

Class<?>[] dictionary

Bean dictionary.

The list of classes that make up the bean dictionary in this bean context.

A dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred through reflection.
The names are defined through the @Marshalled(typeName) annotation defined on the bean class.
For example, if a class Foo has a type-name of "myfoo", then it would end up serialized as "{_type:'myfoo',...}".

This setting tells the parsers which classes to look for when resolving "_type" attributes.

See Also:

• Marshalled.dictionary()
• MarshalledProp.dictionary()
• dictionary_replace()
• MarshallingContext.Builder.beanDictionary(Class...)
• Bean Dictionary

Returns:

The annotation value.

Default:

{}

dictionary_replace

Class<?>[] dictionary_replace

Replace bean dictionary.

Same as dictionary() but replaces any existing value.

See Also:

• Marshalled.dictionary()
• MarshalledProp.dictionary()
• dictionary()
• MarshallingContext.Builder.beanDictionary(Class...)

Returns:

The annotation value.

Default:

{}

locale

String locale

Locale.

Specifies the default locale for serializer and parser sessions.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• MarshallingSession.Builder.locale(Locale)
• MarshallingContext.Builder.locale(Locale)

Returns:

The annotation value.

Default:

""

mediaType

String mediaType

Media type.

Specifies the default media type value for serializer and parser sessions.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• MarshallingSession.Builder.mediaType(MediaType)
• MarshallingContext.Builder.mediaType(MediaType)

Returns:

The annotation value.

Default:

""

rank

int rank

Optional rank for this config.

Can be used to override default ordering and application of config annotations.

Returns:

The annotation value.

Default:

0

swaps

Class<?>[] swaps

Java object swaps.

Swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization, and "swap in" the non-serializable class during parsing.

An example of a swap would be a Calendar object that gets swapped out for an ISO8601 string.

Multiple swaps can be associated with a single class.
When multiple swaps are applicable to the same class, the media type pattern defined by ObjectSwap.forMediaTypes() or @Swap(mediaTypes) are used to come up with the best match.

See Also:

• MarshallingContext.Builder.swaps(Class...)
• Swap
• Per-media-type swaps
• One-way Swaps
• @Swap Annotation
• Auto-detected swaps
• Surrogate Classes

Returns:

The annotation value.

Default:

{}

swaps_replace

Class<?>[] swaps_replace

Replace Java object swap classes.

Same as swaps() but replaces any existing value.

See Also:

• MarshallingContext.Builder.swaps(Class...)

Returns:

The annotation value.

Default:

{}

calendarFormat

CalendarFormat calendarFormat

Calendar wire format.

Returns:

The annotation value.

Default:

NOT_SET

dateFormat

DateFormat dateFormat

Date wire format.

Returns:

The annotation value.

Default:

NOT_SET

durationFormat

DurationFormat durationFormat

Duration wire format.

Returns:

The annotation value.

Default:

NOT_SET

localeFormat

LocaleFormat localeFormat

Locale wire format.

Returns:

The annotation value.

Default:

NOT_SET

periodFormat

PeriodFormat periodFormat

Period wire format.

Returns:

The annotation value.

Default:

NOT_SET

temporalFormat

TemporalFormat temporalFormat

Temporal wire format.

Returns:

The annotation value.

Default:

NOT_SET

timeZoneFormat

TimeZoneFormat timeZoneFormat

Time-zone wire format.

Returns:

The annotation value.

Default:

NOT_SET

binaryFormat

BinaryFormat binaryFormat

Binary wire format for byte[] values.

Returns:

The annotation value.

Default:

NOT_SET

enumFormat

EnumFormat enumFormat

Enum wire format.

Returns:

The annotation value.

Default:

NOT_SET

uuidFormat

UuidFormat uuidFormat

UUID wire format.

Returns:

The annotation value.

Default:

NOT_SET

bitSetFormat

BitSetFormat bitSetFormat

BitSet wire format.

Returns:

The annotation value.

Default:

NOT_SET

bigNumberFormat

BigNumberFormat bigNumberFormat

Big-number wire format for BigInteger / BigDecimal values.

Returns:

The annotation value.

Default:

NOT_SET

booleanFormat

BooleanFormat booleanFormat

Boolean wire format for Boolean / boolean values.

Returns:

The annotation value.

Default:

NOT_SET

floatFormat

FloatFormat floatFormat

Float / Double non-finite wire format for Float / Double values.

Returns:

The annotation value.

Default:

NOT_SET

currencyFormat

CurrencyFormat currencyFormat

Currency wire format for Currency values.

Returns:

The annotation value.

Default:

NOT_SET

classFormat

ClassFormat classFormat

Class wire format for Class values.

Returns:

The annotation value.

Default:

NOT_SET

timeZone

String timeZone

Time zone.

Specifies the default timezone for serializer and parser sessions.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• MarshallingSession.Builder.timeZone(TimeZone)
• MarshallingContext.Builder.timeZone(TimeZone)

Returns:

The annotation value.

Default:

""

typePropertyName

String typePropertyName

Bean type property name.

This specifies the name of the bean property used to store the dictionary name of a bean type so that the parser knows the data type to reconstruct.

Notes:

• Default value: "_type".
• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• Marshalled.typePropertyName()
• MarshallingContext.Builder.typePropertyName(String)

Returns:

The annotation value.

Default:

""