Index.java

/**
 * Copyright (C) 2013 cherimojava (http://github.com/cherimojava/cherimodata) 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 com.github.cherimojava.data.mongo.entity.annotation;

/**
 * Represents a Index, constructed out of multiple IndexFields
 *
 * @author philnate
 * @since 1.0.0
 */
public @interface Index
{
    /**
     * contains a list of all Fields making this Index
     */
    public IndexField[]value();

    /**
     * Is this index unique or not? Default false
     */
    public boolean unique() default false;

    /**
     * Optional name of the index, if not set system generated name will be used
     */
    public String name() default "";
}