/*

 * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.management;

import java.beans.ConstructorProperties;

/**

 * Diagnostic Command Argument information. It contains the description

 * of one parameter of the diagnostic command. A parameter can either be an

 * option or an argument. Options are identified by the option name while

 * arguments are identified by their position in the command line. The generic

 * syntax of a diagnostic command is:

 *  <blockquote>

 *    <command name> [<option>=<value>] [<argument_value>]

 * </blockquote>

 * Example:

 * <blockquote>

 * command_name option1=value1 option2=value argumentA argumentB argumentC

 * </blockquote>

 * In this command line, the diagnostic command receives five parameters, two

 * options named {@code option1} and {@code option2}, and three arguments.

 * argumentA's position is 0, argumentB's position is 1 and argumentC's

 * position is 2.

 *

 * @author  Frederic Parain

 * @since   7u4

 */

public class DiagnosticCommandArgumentInfo {

    private final String name;

    private final String description;

    private final String type;

    private final String defaultValue;

    private final boolean mandatory;

    private final boolean option;

    private final int position;

    /**

     * Returns the argument name

     *

     * @return the argument name

     */

    public String getName() {

        return name;

    }

   /**

     * Returns the argument description

     *

     * @return the argument description

     */

    public String getDescription() {

        return description;

    }

    /**

     * Returns the argument type

     *

     * @return the argument type

     */

    public String getType() {

        return type;

    }

    /**

     * Returns the default value as a String if a default value

     * is defined, null otherwise.

     *

     * @return the default value as a String if a default value

     * is defined, null otherwise.

     */

    public String getDefault() {

        return defaultValue;

    }

    /**

     * Returns {@code true} if the argument is mandatory,

     *         {@code false} otherwise

     *

     * @return {@code true} if the argument is mandatory,

     *         {@code false} otherwise

     */

    public boolean isMandatory() {

        return mandatory;

    }

    /**

     * Returns {@code true} if the argument is an option,

     *         {@code false} otherwise. Options have to be specified using the

     *         <key>=<value> syntax on the command line, while other

     *         arguments are specified with a single <value> field and are

     *         identified by their position on command line.

     *

     * @return {@code true} if the argument is an option,

     *         {@code false} otherwise

     */

    public boolean isOption() {

        return option;

    }

    /**

     * Returns the expected position of this argument if it is not an option,

     *         -1 otherwise. Argument position if defined from left to right,

     *         starting at zero and ignoring the diagnostic command name and

     *         options.

     *

     * @return the expected position of this argument if it is not an option,

     *         -1 otherwise.

     */

    public int getPosition() {

        return position;

    }

    @ConstructorProperties({"name","description","type","default",

                "mandatory","option","position"})

    public DiagnosticCommandArgumentInfo(String name, String description,

                                         String type, String defaultValue,

                                         boolean mandatory, boolean option,

                                         int position) {

        this.name = name;

        this.description = description;

        this.type = type;

        this.defaultValue = defaultValue;

        this.mandatory = mandatory;

        this.option = option;

        this.position = position;

    }

}