ch.rasc.bsoncodec.annotation.Field Maven / Gradle / Ivy
Show all versions of bsoncodec-apt Show documentation
/**
* Copyright 2015-2016 Ralph Schaer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package ch.rasc.bsoncodec.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.AbstractCollection;
import java.util.Collection;
import java.util.Iterator;
import org.bson.BsonReader;
import org.bson.BsonWriter;
import org.bson.codecs.Codec;
import org.bson.codecs.DecoderContext;
import org.bson.codecs.EncoderContext;
/**
* Marks a instance field to be part of the {@link Codec}. (Optional)
*
* By default the annotation processor takes every instance field into account that is not
* annotated with {@link Transient} and has a corresponding get and set method. The
* {@link Field} annotation is only need when the default behavior should be overridden.
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.SOURCE)
public @interface Field {
/**
* The key to be used to store the field inside the document.
*
* By default the name of the field is used.
*/
String value() default "";
/**
* 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.
*/
int order() default Integer.MAX_VALUE;
/**
* A custom {@link Codec} implementation that handles encoding and decoding of the
* annotated field
*/
Class> codec() default NullCodec.class;
/**
* 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 codec specified.
*
* i.e.
* @Field(fixedArray=2)
* private double[] lngLat;
*
*/
int fixedArray() default 0;
/**
* Specifies the {@link 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 {@link Collection} implementation
*
* Default mappings
*
*
*
* Interface
* Implementation
*
*
* {@link java.util.Collection}
* {@link java.util.ArrayList}
*
*
* {@link java.util.List}
* {@link java.util.ArrayList}
*
*
* {@link java.util.Set}
* {@link java.util.LinkedHashSet}
*
*
* {@link java.util.SortedSet}
* {@link java.util.TreeSet}
*
*
* {@link java.util.NavigableSet}
* {@link java.util.TreeSet}
*
*
* {@link java.util.concurrent.BlockingDeque}
* {@link java.util.concurrent.LinkedBlockingDeque}
*
*
* {@link java.util.concurrent.BlockingQueue}
* {@link java.util.concurrent.LinkedBlockingQueue}
*
*
* {@link java.util.Deque}
* {@link java.util.concurrent.LinkedBlockingDeque}
*
*
* {@link java.util.Queue}
* {@link java.util.concurrent.LinkedBlockingQueue}
*
*
* {@link java.util.concurrent.TransferQueue}
* {@link java.util.concurrent.LinkedTransferQueue}
*
*
*/
@SuppressWarnings("rawtypes")
Class collectionImplementationClass() default NullCollection.class;
public static class NullCodec implements Codec