org.panteleyev.mysqlapi.annotations.Index Maven / Gradle / Ivy

Go to download

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

Annotation based Java API for MySQL database.

The newest version!

/*
 Copyright (c) Petr Panteleyev. All rights reserved.
 Licensed under the BSD license. See LICENSE file in the project root for full license information.
 */
package org.panteleyev.mysqlapi.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Defines index for the table column.
 */

@Retention(RUNTIME)
@Target({FIELD, PARAMETER})
public @interface Index {
    /**
     * Name of the index.
     * @return name of the index
     */
    String value();

    /**
     * Specifies whether this index must be unique.
     * @return unique
     */
    boolean unique() default false;
}