Coverage Report - org.apache.commons.cli2.Group
 
Classes in this File Line Coverage Branch Coverage Complexity
Group
N/A
N/A
1
 
 1  
 /**
 2  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 3  
  * contributor license agreements.  See the NOTICE file distributed with
 4  
  * this work for additional information regarding copyright ownership.
 5  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 6  
  * (the "License"); you may not use this file except in compliance with
 7  
  * the License.  You may obtain a copy of the License at
 8  
  *
 9  
  *     http://www.apache.org/licenses/LICENSE-2.0
 10  
  *
 11  
  * Unless required by applicable law or agreed to in writing, software
 12  
  * distributed under the License is distributed on an "AS IS" BASIS,
 13  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14  
  * See the License for the specific language governing permissions and
 15  
  * limitations under the License.
 16  
  */
 17  
 package org.apache.commons.cli2;
 18  
 
 19  
 import java.util.Comparator;
 20  
 import java.util.Set;
 21  
 
 22  
 /**
 23  
  * An Option representing a choice or group of Options in the form "-a|-b|-c".
 24  
  */
 25  
 public interface Group extends Option {
 26  
 
 27  
     /**
 28  
      * Appends usage information to the specified StringBuffer
 29  
      *
 30  
      * @param buffer the buffer to append to
 31  
      * @param helpSettings a set of display settings @see DisplaySetting
 32  
      * @param comp a comparator used to sort the Options
 33  
      * @param separator the String used to separate member Options
 34  
      */
 35  
     void appendUsage(
 36  
         final StringBuffer buffer,
 37  
         final Set helpSettings,
 38  
         final Comparator comp,
 39  
         final String separator);
 40  
 
 41  
     /**
 42  
      * Indicates whether group members must be present for the CommandLine to be
 43  
      * valid.
 44  
      *
 45  
      * @see #getMinimum()
 46  
      * @see #getMaximum()
 47  
      * @return true iff the CommandLine will be invalid without at least one
 48  
      *         member option
 49  
      */
 50  
     boolean isRequired();
 51  
 
 52  
     /**
 53  
      * Retrieves the minimum number of members required for a valid Group
 54  
      *
 55  
      * @return the minimum number of members
 56  
      */
 57  
     int getMinimum();
 58  
 
 59  
     /**
 60  
      * Retrieves the maximum number of members acceptable for a valid Group
 61  
      *
 62  
      * @return the maximum number of members
 63  
      */
 64  
     int getMaximum();
 65  
 }