io.objectbox.annotation.Index Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of objectbox-java-api Show documentation

ObjectBox is a fast NoSQL database for Objects

There is a newer version: 4.2.0

/*
 * Copyright 2017-2018 ObjectBox Ltd. All rights reserved.
 *
 * 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 io.objectbox.annotation;

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

/**
 * Specifies that the property should be indexed.
 * 
 * It is highly recommended to index properties that are used in a query to improve query performance.
 * When building a query, make sure to use case sensitive String conditions to utilize the index.
 * 

 * To fine tune indexing of a property you can override the default index {@link #type()}.
 * 
 * Note: indexes are currently not supported for string array, byte array, float or double properties.
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface Index {
    /**
     * Sets the {@link IndexType}, defaults to {@link IndexType#DEFAULT}.
     */
    IndexType type() default IndexType.DEFAULT;
}