com.asakusafw.lang.inspection.cli.RichOption.java Source code

Introduction

Here is the source code for com.asakusafw.lang.inspection.cli.RichOption.java

Source

/**
 * Copyright 2011-2017 Asakusa Framework Team.
 *
 * 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.asakusafw.lang.inspection.cli;

import org.apache.commons.cli.Option;

/**
 * A wrapped option.
 */
public final class RichOption extends Option {

    private static final long serialVersionUID = -1026326254581683622L;

    /**
     * Creates a new instance.
     * @param shortName the short name
     * @param longName the long name
     * @param numerOfArguments the number of arguments
     * @param required whether this option is required or not
     */
    public RichOption(String shortName, String longName, int numerOfArguments, boolean required) {
        super(shortName, longName, false, null);
        setArgs(numerOfArguments);
        setRequired(required);
    }

    /**
     * Sets the option description.
     * @param value the description
     * @return this
     */
    public RichOption withDescription(String value) {
        setDescription(value);
        return this;
    }

    /**
     * Sets the argument description.
     * @param value the description
     * @return this
     */
    public RichOption withArgumentDescription(String value) {
        setArgName(value);
        return this;
    }

    /**
     * Sets the value separator.
     * @param separator the key-value separator
     * @return this
     */
    public RichOption withValueSeparator(char separator) {
        this.setValueSeparator(separator);
        return this;
    }
}