• Home
• com.github.raphcal
• argument-parser
• 1.2
• source code
• Option.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.raphcal.argparser.Option Maven / Gradle / Ivy

/*
 * Copyright (C) 2018 Raphaël Calabro .
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301  USA
 */
package com.github.raphcal.argparser;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Describes an option (also called a flag).
 * 
 * @author Raphaël Calabro ([email protected])
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface Option {
	/**
	 * Alias to use instead of the property name for the option.
	 * 

	 * Useful to change an option name from camelCase to dash-case.
	 * 
	 * @return the alias of the option.
	 */
	String alias() default "";
	
	/**
	 * Description to print in the usage.
	 * 
	 * @return the description of the description.
	 */
	String description();
	
	/**
	 * Should be set to true if this option can be used without
	 * the required arguments (for example: help option or version option).
	 * 
	 * @return true if this option is autonomous, false otherwise.
	 */
	boolean autonomous() default false;
}