com.caucho.v5.cli.spi.OptionCommandLine Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of baratine Show documentation
Show all versions of baratine Show documentation
A reactive Java web server.
/*
* Copyright (c) 1998-2015 Caucho Technology -- all rights reserved
*
* This file is part of Baratine(TM)
*
* Each copy or derived work must preserve the copyright notice and this
* notice unmodified.
*
* Baratine is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Baratine 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, or any warranty
* of NON-INFRINGEMENT. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with Baratine; if not, write to the
*
* Free Software Foundation, Inc.
* 59 Temple Place, Suite 330
* Boston, MA 02111-1307 USA
*
* @author Scott Ferguson
*/
package com.caucho.v5.cli.spi;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
public interface OptionCommandLine
{
String getName();
default String envName(ArgsBase args)
{
return args.getProgramName() + "." + getName().replace('-', '.');
}
default void property(ArgsBase args, String value)
{
args.property(envName(args), value);
}
int parse(A args, String []argv, int index)
throws CommandArgumentException;
String usage(ArgsBase args);
String getTinyName();
ArgsType getType();
String getValueDescription();
String getDescription();
boolean isFlag();
//
// builder
//
OptionCommandLine parser(OptionContainer parser);
OptionCommandLine alias(String name);
OptionCommandLine tiny(String name);
OptionCommandLine type(ArgsType type);
OptionCommandLine deprecated();
OptionCommandLine hide();
OptionCommandLine required();
public enum ArgsType {
COMMAND,
GENERAL,
ADMIN,
DEBUG,
DEFAULT;
}
abstract public static class Base
implements OptionCommandLine
{
private OptionContainer _parser;
private boolean _isDeprecated;
private boolean _isRequired;
private List _tinyNameList;
private ArgsType _type = ArgsType.DEFAULT;
@Override
public String getName()
{
StringBuilder sb = new StringBuilder();
String className = getClass().getSimpleName();
for (int i = 0; i < className.length(); i++) {
char ch = className.charAt(i);
if (Character.isUpperCase(ch)) {
if (i > 0) {
sb.append("-");
}
sb.append(Character.toLowerCase(ch));
}
else {
sb.append(ch);
}
}
return sb.toString();
}
@Override
public ArgsType getType()
{
return _type;
}
@Override
public String getTinyName()
{
return null;
}
@Override
public String getDescription()
{
return null;
}
@Override
public String getValueDescription()
{
return null;
}
@Override
public boolean isFlag()
{
return false;
}
@Override
public String usage(ArgsBase args)
{
if (_isDeprecated) {
return null;
}
StringBuilder sb = new StringBuilder();
sb.append("\n ");
int padding = 9;
if (_tinyNameList != null) {
for (String tinyName : _tinyNameList) {
sb.append("-").append(tinyName).append(", ");
padding -= 1 + tinyName.length() + 2;
}
}
for (int i = padding; i > 0; i--) {
sb.append(" ");
}
String name = getName();
sb.append("--").append(name);
String valueDesc = getValueDescription();
if (! isFlag()) {
if (valueDesc != null) {
sb.append(" ").append(valueDesc);
}
}
if (getDescription() != null) {
int nameLen = name.length();
if (valueDesc != null && ! isFlag()) {
nameLen += valueDesc.length() + 1;
}
for (int i = nameLen; i < 20; i++) {
sb.append(" ");
}
sb.append(" ").append(getDescription());
}
if (_isRequired) {
sb.append(", required");
}
return sb.toString();
}
//
// builder
//
@Override
public OptionCommandLine alias(String name)
{
Alias alias = new Alias(this, name);
_parser.addOption(alias);
return alias;
}
@Override
public OptionCommandLine tiny(String name)
{
Alias alias = new Alias(this, name);
_parser.addTinyOption(alias);
if (_tinyNameList == null) {
_tinyNameList = new ArrayList();
}
if (! _tinyNameList.contains(name)) {
_tinyNameList.add(name);
}
return alias;
}
@Override
public OptionCommandLine deprecated()
{
_isDeprecated = true;
return this;
}
@Override
public OptionCommandLine hide()
{
_isDeprecated = true;
return this;
}
@Override
public OptionCommandLine required()
{
_isRequired = true;
return this;
}
@Override
public OptionCommandLine type(ArgsType type)
{
Objects.requireNonNull(type);
_type = type;
return this;
}
@Override
public OptionCommandLine parser(OptionContainer parser)
{
_parser = parser;
return this;
}
//
// values
//
protected void addStringValue(X args, String value)
{
args.addOption(getName(), new ArgValueCli.ValueString(this, value));
}
protected void addMultiStringValue(X args, String value)
{
args.addOption(getName(), new ArgValueCli.ValueMultiString(this, value));
}
protected void addBooleanValue(X args, boolean value)
{
args.addOption(getName(), new ArgValueCli.ValueString(this, String.valueOf(value)));
}
}
static class Alias implements OptionCommandLine
{
private OptionCommandLine _delegate;
private String _name;
private String _description;
Alias(OptionCommandLine delegate, String name)
{
_delegate = delegate;
_name = name;
}
@Override
public String getName()
{
return _name;
}
public ArgsType getType()
{
return ArgsType.COMMAND;
}
@Override
public String getTinyName()
{
return null;
}
@Override
public String getDescription()
{
return _description;
}
@Override
public String getValueDescription()
{
return null;
}
@Override
public boolean isFlag()
{
return _delegate.isFlag();
}
@Override
public int parse(X args, String[] argv, int index)
throws CommandArgumentException
{
return _delegate.parse(args, argv, index);
}
@Override
public String usage(ArgsBase args)
{
return null;
}
@Override
public OptionCommandLine alias(String name)
{
return _delegate.alias(name);
}
@Override
public OptionCommandLine tiny(String name)
{
return _delegate.tiny(name);
}
@Override
public OptionCommandLine type(ArgsType type)
{
return _delegate.type(type);
}
@Override
public OptionCommandLine deprecated()
{
_delegate.deprecated();
return this;
}
@Override
public OptionCommandLine hide()
{
_delegate.hide();
return this;
}
@Override
public OptionCommandLine required()
{
_delegate.required();
return this;
}
@Override
public OptionCommandLine parser(OptionContainer parser)
{
return this;
}
}
static class IgnoreFlag extends Base {
private String _name;
private String _description;
public IgnoreFlag(String name, String description)
{
_name = name;
_description = description;
}
@Override
public String getName()
{
return _name;
}
@Override
public String getDescription()
{
return _description;
}
@Override
public int parse(ArgsBase args, String []argv, int index)
throws CommandArgumentException
{
return index;
}
}
static class IgnoreValue extends Base {
private String _name;
private String _description;
public IgnoreValue(String name, String description)
{
_name = name;
_description = description;
}
@Override
public String getName()
{
return _name;
}
@Override
public String getDescription()
{
return _description;
}
@Override
public int parse(ArgsBase args, String []argv, int index)
throws CommandArgumentException
{
return index + 1;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy