net.java.ao.schema.Index Maven / Gradle / Ivy

Go to download

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

This is the full Active Objects library, if you don't know which one to use, you probably want this one.

The newest version!

package net.java.ao.schema;

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

/**
 * Defines a database index.
 *
 * 
 *     The index can be either simple or composite.
 *     Please note that the actual name of the index may differ. This field is case insensitive.
 * 
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({})
public @interface Index {

    /**
     * @return the table unique index name.
     */
    String name();

    /**
     * @return an array of accessors or mutators to the columns that should be included in the index.
     */
    String[] methodNames();

    boolean unique() default false;
}