org.netbeans.spi.sendopts.OptionGroups Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.netbeans.spi.sendopts;
/** Factory method that composes individual options into groups.
* In some situations it is useful and sometimes even necessary to
* enforce certain relationships among options provided by some,
* potentially different modules. Factory methods defined here in allow such
* compositions as they take multiple options and convert them
* into one group option.
*
* The following table gives short overview of the behaviour of different
* factory methods. Supposed n individual options were passed as
* arguments to each method. The Min and Max shown the
* number that is needed for the group option to be "consistent":
*
*
* Behaviour overview
*
* Method
* Min
* Max
*
*
*
* {@link OptionGroups#allOf}
* n
* n
*
*
*
* {@link OptionGroups#oneOf}
* 1
* 1
*
*
*
* {@link OptionGroups#someOf}
* 1
* n
*
*
*
* {@link OptionGroups#anyOf}
* 0
* n
*
*
*
*
* Please note that the {@link OptionGroups#anyOf} is in fact always consistent,
* regardless any number of the given options appears on the command line or not.
* As such it serves slightly different purpose than the other methods listed
* in the table.
*
* More detailed description of the behaviour of each method is given in
* their appropriate javadoc.
*
* @author Jaroslav Tulach
*/
public final class OptionGroups {
private OptionGroups() {
}
/** Combines a set of multiple options into one compound one. Useful
* for {@link OptionProcessor} that want to process more than one
* option and want to do all the logic of choosing which options can
* be used together with others by themselves. The newly created
* options will be contained in the map passed to
* {@link OptionProcessor#process} method if at least one of the
* parameters appeared on the command line. The value associated with
* the compound option is always going to be new String[0], however
* the map will contain all options that appeared and their values which
* can then be processed one by one.
*
* @param options the sub options to check on the command line
* @return compound option that is activated if at least one of the
* options appears on the command line
*/
public static Option someOf(Option... options) {
return new Option(2, options);
}
/** A voluntary selector that allows any of the specified options to appear
* on the command line, but if they do not appear, the command line is
* still consistent. If at least one of the given sub options appears on
* the command line, the map passed to
* {@link OptionProcessor#process} will contain the returned compound option
* with associated value of new String[0].
*
* @param options the sub options to check on the command line
* @return compound option that is activated if at least one of the
* options appears on the command line
*/
public static Option anyOf(Option... options) {
return new Option(3, options);
}
/** Creates a selector option that forces exactly one of the sub options
* to appear on the command line. If more than
* one of the options appears on the command line, then an error is
* reported by the infrastructure. If none of the sub options is present
* than this selector option is not also present.
* If present in the {@link OptionProcessor#process}'s
* map, then the selector option is always associated with new String[0]
* value, however there is also one of the sub options, with its associated
* value.
*
* @param options the options to select one from
* @return the selector option
*/
public static Option oneOf(Option... options) {
return new Option(0, options);
}
/** Creates a compound option that forces all of the sub options
* to appear on the command line. If less of them is present, an error
* is reported by the infrastructure.
* If present in the {@link OptionProcessor#process}'s
* map, then the compound option is always associated with new String[0]
* value, however there are all the sub options, with their associated
* values.
*
* @param options the options to select one from
* @return the selector option
*/
public static Option allOf(Option... options) {
return new Option(1, options);
}
}