it.jnrpe.yaclp.IOption Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cli-parser Show documentation

A java command line parser

There is a newer version: 1.0.4

/*******************************************************************************
 * Copyright (c) 2017 Massimiliano Ziccardi
 *
 * 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 it.jnrpe.yaclp;

import java.util.List;

/**
 * Generic option interface.
 */
public interface IOption {
    /**
     * Returns the short name for this option.
     * @return the short name for this option
     */
    String getShortName();

    /**
     * Returns the long name for this option.
     * @return Returns the long name for this option.
     */
    String getLongName();

    /**
     * Checks if this option is mandatory
     * @return  true or false
     */
    boolean isMandatory();

    String getDescription();
}