com.github.rvesse.airline.restrictions.factories.GlobalRestrictionFactory Maven / Gradle / Ivy

Go to download

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

Java library provided an annotation-based framework for parsing Git like command line structures

There is a newer version: 3.0.0

/**
 * 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.restrictions.factories;

import java.lang.annotation.Annotation;
import java.util.List;

import com.github.rvesse.airline.restrictions.GlobalRestriction;

/**
 * Interface for option restriction factories
 */
public interface GlobalRestrictionFactory {

    /**
     * Try and create a global restriction from the given annotation
     * 
     * @param annotation
     *            Annotation
     * @return Global restriction or {@code null} if this factory cannot create
     *         a restriction from the given annotation
     */
    public abstract GlobalRestriction createGlobalRestriction(Annotation annotation);

    /**
     * Gets a list of annotations that this factory can convert into global
     * restrictions
     * 
     * @return List of supported annotations
     */
    public List> supportedGlobalAnnotations();
}