com.googlecode.objectify.annotation.Indexed Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of objectify Show documentation

*** THIS VERSION UPLOADED FOR USE WITH CEDAR-COMMON, TO AVOID DEPENDENCIES ON GOOGLE CODE-BASED MAVEN REPOSITORIES. *** The simplest convenient interface to the Google App Engine datastore

The newest version!

package com.googlecode.objectify.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.googlecode.objectify.condition.If;

/**
 * This annotation controls whether or not fields are indexed in the datastore.
 * 
 * When placed on a simple field, the field will be indexed if possible.  Text,
 * Blob, and @Serialized fields cannot be indexed.  If the field is an @Embedded
 * class or a collection of @Embedded classes, the fields of those classes will
 * be indexed as if the class had the @Indexed annotation.
 * 
 * When placed on an entity class or an embedded class, this sets the default
 * for all fields to be indexed.  It can be overridden by field level annotations.
 * 
 * If an embedded class field is annotated with @Indexed, any @Indexed or @Unindexed
 * annotation on the class itself is ignored.
 * 
 * If passed one or more classes that implement the {@code If} interface, the
 * value will be indexed only if it tests positive for any of the conditions.  This
 * allows "partial indexing" of only some categories of values (ie, true but not false).
 * 
 * @author Scott Hernandez >[] value() default { com.googlecode.objectify.condition.Always.class };
}