ch.rasc.bsoncodec.annotation

Annotation Type Field

@Target(value=FIELD)
 @Retention(value=SOURCE)
public @interface Field

Marks a instance field to be part of the Codec. (Optional)

By default the annotation processor takes every instance field into account that is not annotated with Transient and has a corresponding get and set method. The Field annotation is only needed when the default behavior should be overridden.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends org.bson.codecs.Codec<?>>	codec A custom Codec implementation that handles encoding and decoding of the annotated field
Class<? extends Collection>	collectionImplementationClass Specifies the Collection implementation to be used in the decoding phase.
int	fixedArray Denotes an array as a fixed length array.
int	order The order in which the field should be stored.
String	value The key to be used to store the field inside the document.

Element Detail

value

public abstract String value

The key to be used to store the field inside the document.

By default the name of the field is used.

Default:

""

order

public abstract int order

The order in which the field should be stored.

By default the fields are stored in the order they appear in the class. Except the id field which is always stored first.

Default:

2147483647

codec

public abstract Class<? extends org.bson.codecs.Codec<?>> codec

A custom Codec implementation that handles encoding and decoding of the annotated field

Default:

ch.rasc.bsoncodec.annotation.Field.NullCodec.class

fixedArray

public abstract int fixedArray

Denotes an array as a fixed length array. Such an array is null or contains always the specified number of elements. This is a micro-optimisation hint for the decoder code generation.

This attribute is ignored for non-array fields or for fields that have a custom codec specified.

i.e. @Field(fixedArray=2) private double[] lngLat;

Default:

0

collectionImplementationClass

public abstract Class<? extends Collection> collectionImplementationClass

Specifies the Collection implementation to be used in the decoding phase.

There is no need to specify this attribute when the default mapping is sufficient or when the type of the field is already a Collection implementation

Default mappings

Interface	Implementation
Collection	ArrayList
List	ArrayList
Set	LinkedHashSet
SortedSet	TreeSet
NavigableSet	TreeSet
BlockingDeque	LinkedBlockingDeque
BlockingQueue	LinkedBlockingQueue
Deque	LinkedBlockingDeque
Queue	LinkedBlockingQueue
TransferQueue	LinkedTransferQueue

Default:

ch.rasc.bsoncodec.annotation.Field.NullCollection.class