com.basho.riak.client.convert.RiakIndex Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of riak-client Show documentation

HttpClient-based client for Riak

There is a newer version: 2.1.1

/*
 * This file is provided to you 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 com.basho.riak.client.convert;

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

import com.basho.riak.client.bucket.DefaultBucket;

/**
 * Annotation to declare a field as a RiakIndex.
 * 
 * You do not need to specify the index type prefix (_bin/_int). It will be
 * inferred from the type of the annotated field. 
 * 
 * Only String/Long/long or {@code Set} / {@code Set}  fields
 * may be annotated with RiakIndex. 
 * 
 * Prior to v1.1.0 the _int index support was implemented using int / Integer.
 * The current code still supports this for legacy purposes 
 * but all new code should use long / Long
 * 
 * 
 * 
 * NOTE: if there are *multiple* values for the same named index and the field
 * in the domain object is an long, Long, or String only the 1st will find 
 * it's way into the domain object
 * 
 * 
 * For example: 
 * 
 *  * 
 * public class MyClass {
 *     @RiakKey
 *     private String myKeyString;
 *     
 *     @RiakIndex(name="email")
 *     private String emailAddress; // will be indexed in email_bin index
 *     
 *     @RiakIndex(name="age")
 *     private long age; // will be index in age_int index
 * }
 *  
 * 
 * 
 * 
 * 
 * @author russell
 * @see JSONConverter
 * @see DefaultBucket
 */
@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.METHOD}) public @interface RiakIndex {
    /**
     * @return the index name
     */
    String name() default "";
}