Home | History | Annotate | Download | only in checker
      1 /*
      2  * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions
      6  * are met:
      7  *
      8  *   - Redistributions of source code must retain the above copyright
      9  *     notice, this list of conditions and the following disclaimer.
     10  *
     11  *   - Redistributions in binary form must reproduce the above copyright
     12  *     notice, this list of conditions and the following disclaimer in the
     13  *     documentation and/or other materials provided with the distribution.
     14  *
     15  *   - Neither the name of Oracle nor the names of its
     16  *     contributors may be used to endorse or promote products derived
     17  *     from this software without specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
     20  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
     21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
     23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
     27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
     28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 /*
     33  * This source code is provided to illustrate the usage of a given feature
     34  * or technique and has been deliberately simplified. Additional steps
     35  * required for a production-quality application, such as security checks,
     36  * input validation and proper error handling, might not be present in
     37  * this sample code.
     38  */
     39 package checker;
     40 
     41 import java.lang.annotation.Repeatable;
     42 import java.lang.annotation.Retention;
     43 import java.lang.annotation.RetentionPolicy;
     44 
     45 /**
     46  * Indicates that a plug-in depends on a module.
     47  */
     48 @Retention(RetentionPolicy.CLASS)
     49 @Repeatable(RequireContainer.class)
     50 public @interface Require {
     51 
     52     /**
     53      * Returns the required module.
     54      *
     55      * @return required module.
     56      */
     57     Module value();
     58 
     59     /**
     60      * Returns the minimum supported version of a module.
     61      *
     62      * @return minimum supported version of a module.
     63      */
     64     int minVersion() default 1;
     65 
     66     /**
     67      * Returns the maximum supported version of a module.
     68      *
     69      * @return maximum supported version of a module.
     70      */
     71     int maxVersion() default Integer.MAX_VALUE;
     72 
     73     /**
     74      * Returns true if a module is optional. A module is optional if a system
     75      * works without that module but is missing some functionality. Returns false if a system
     76      * won't work without the specified module.
     77      *
     78      * @return true if module is optional. False otherwise.
     79      */
     80     boolean optional() default false;
     81 }
     82