io.permazen.annotation.ValuesList Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of permazen-main Show documentation

Permazen classes that map Java model classes onto the core API.

The newest version!


/*
 * Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
 */

package io.permazen.annotation;

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

/**
 * Defines a predicate that matches certain combined values of a list of simple fields.
 */
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ValuesList {

    /**
     * Get the matching criteria for each field in the list.
     *
     * 
     * The i^th {@link Values @Values} in the returned array corresponds to the i^th field
     * in the list. In order for the list of fields to match, all of the fields in the list must match their
     * respective {@link Values @Values} annotation.
     *
     * @return list of field matching criteria
     */
    Values[] value();
}