com.github.rvesse.airline.examples.cli.AbbreviationCli Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of airline-examples Show documentation
Provides a variety of examples of using Airline
There is a newer version: 3.0.0
/**
 * Copyright (C) 2010-16 the original author or authors.
 *
 * 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.github.rvesse.airline.examples.cli;

import com.github.rvesse.airline.Cli;
import com.github.rvesse.airline.builder.CliBuilder;
import com.github.rvesse.airline.examples.ExampleExecutor;
import com.github.rvesse.airline.examples.ExampleRunnable;
import com.github.rvesse.airline.examples.cli.commands.Help;
import com.github.rvesse.airline.examples.inheritance.Child;
import com.github.rvesse.airline.examples.inheritance.GoodGrandchild;
import com.github.rvesse.airline.examples.inheritance.Parent;
import com.github.rvesse.airline.examples.simple.Required;
import com.github.rvesse.airline.examples.simple.RequiredArguments;
import com.github.rvesse.airline.examples.simple.Simple;

/**
 * An example of creating a CLI with abbreviation enabled
 * 
 * Command/Group and/or Option abbreviation allows you to configure Airline such
 * that it permits the names of groups, commands and options provided that those
 * names are unambiguous.  For example the following abbreviation would be acceptable:
 * 
 *  * in par
 * 
 * 
 * Whereas the following would not (because it is ambiguous):
 * 
 *  * basic req
 * 
 */
public class AbbreviationCli {

    @SuppressWarnings("unchecked")
    public static void main(String[] args) {
        //@formatter:off
        // The program name is cli
        CliBuilder builder = Cli.builder("cli")
                                                 // Add a description
                                                 .withDescription("A simple CLI with several commands available in groups");
        
        // We can enable command and option abbreviation, this allows users to only
        // type part of the group/command/option name provided that the portion they
        // type is unambiguous
        builder.withParser()
               .withCommandAbbreviation()
               .withOptionAbbreviation();
        
        // Add a basic group
        builder.withGroup("basic")
               .withDescription("Basic commands")
               .withCommands(Simple.class, Required.class, RequiredArguments.class);
        // Add another group
        builder.withGroup("inheritance")
               .withDescription("Commands that demonstrate option inheritance")
               .withCommands(Parent.class, Child.class, GoodGrandchild.class);
        // You can still define top level commands as well 
        builder.withCommand(Help.class);
        //@formatter:on

        ExampleExecutor.executeCli(builder.build(), args);
    }

}