com.github.rvesse.airline.annotations.restrictions.Partial Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2010-16 the original author or authors.
 *
 * 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.rvesse.airline.annotations.restrictions;

import static java.lang.annotation.ElementType.FIELD;

import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import com.github.rvesse.airline.annotations.Arguments;
import com.github.rvesse.airline.annotations.Option;

/**
 * Annotation which is used as a modifier to indicate that a restriction
 * annotation (whose type is denoted by the {@link #restriction()} field) does
 * not apply to all values passed to an {@link Option} or {@link Arguments}
 * annotated field but rather applies only to certain values
 * 
 * @author rvesse
 *
 */
@Retention(java.lang.annotation.RetentionPolicy.RUNTIME)
@Target({ FIELD })
@Documented
public @interface Partial {

    /**
     * Specifies the indices (zero-based) to which the restriction should
     * actually apply
     * 
     * @return Indices to which the restriction applies
     */
    int[] appliesTo();

    /**
     * Specifies the restriction type whose application should be partial
     * 
     * @return Restriction type
     */
    Class restriction();
}