components/visual-panels/core/src/java/util/com/oracle/solaris/vp/util/cli/OptionGroup.java
changeset 827 0944d8c0158b
equal deleted inserted replaced
826:c6aad84d2493 827:0944d8c0158b
       
     1 /*
       
     2  * CDDL HEADER START
       
     3  *
       
     4  * The contents of this file are subject to the terms of the
       
     5  * Common Development and Distribution License (the "License").
       
     6  * You may not use this file except in compliance with the License.
       
     7  *
       
     8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
       
     9  * or http://www.opensolaris.org/os/licensing.
       
    10  * See the License for the specific language governing permissions
       
    11  * and limitations under the License.
       
    12  *
       
    13  * When distributing Covered Code, include this CDDL HEADER in each
       
    14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
       
    15  * If applicable, add the following below this CDDL HEADER, with the
       
    16  * fields enclosed by brackets "[]" replaced with your own identifying
       
    17  * information: Portions Copyright [yyyy] [name of copyright owner]
       
    18  *
       
    19  * CDDL HEADER END
       
    20  */
       
    21 
       
    22 /*
       
    23  * Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved.
       
    24  */
       
    25 
       
    26 package com.oracle.solaris.vp.util.cli;
       
    27 
       
    28 import java.util.*;
       
    29 
       
    30 public abstract class OptionGroup extends Option {
       
    31     //
       
    32     // Instance data
       
    33     //
       
    34 
       
    35     private boolean required;
       
    36     private boolean documented;
       
    37     private List<Option> options = new ArrayList<Option>();
       
    38 
       
    39     // Used when processing options
       
    40     private List<Option> usedOptions = new ArrayList<Option>();
       
    41 
       
    42     //
       
    43     // Constructors
       
    44     //
       
    45 
       
    46     public OptionGroup(boolean required) {
       
    47 	setRequired(required);
       
    48 	setDocumented(true);
       
    49     }
       
    50 
       
    51     public OptionGroup(boolean required, Option[] options) {
       
    52 	this(required);
       
    53 	this.options.addAll(Arrays.asList(options));
       
    54     }
       
    55 
       
    56     //
       
    57     // Option methods
       
    58     //
       
    59 
       
    60     @Override
       
    61     public boolean isDocumented() {
       
    62 	return documented;
       
    63     }
       
    64 
       
    65     @Override
       
    66     public boolean isRequired() {
       
    67 	return required;
       
    68     }
       
    69 
       
    70     //
       
    71     // OptionGroup methods
       
    72     //
       
    73 
       
    74     public void addOption(Option option) {
       
    75 	synchronized (options) {
       
    76 	    options.add(option);
       
    77 	}
       
    78     }
       
    79 
       
    80     protected List<Option> getOptions() {
       
    81 	return options;
       
    82     }
       
    83 
       
    84     public List<Option> getUsedOptions() {
       
    85 	return usedOptions;
       
    86     }
       
    87 
       
    88     protected boolean removeOption(Option option) {
       
    89 	synchronized (options) {
       
    90 	    return options.remove(option);
       
    91 	}
       
    92     }
       
    93 
       
    94     public void setDocumented(boolean documented) {
       
    95 	this.documented = documented;
       
    96     }
       
    97 
       
    98     public void setRequired(boolean required) {
       
    99 	this.required = required;
       
   100     }
       
   101 
       
   102     //
       
   103     // Private methods
       
   104     //
       
   105 
       
   106     private void addUsedOption(Option option) {
       
   107 	usedOptions.add(option);
       
   108     }
       
   109 
       
   110     private boolean removeUsedOption(Option option) {
       
   111 	return usedOptions.remove(option);
       
   112     }
       
   113 }