com.github.rvesse.airline.examples.cli.aliases.PositionalAliasedCli 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.aliases;

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.Simple;

/**
 * An example of creating a CLI that takes advantage of the aliases feature.
 * 
 * Aliases provide a means by which you can define additional top level commands
 * that simply delegate to actual commands. In this example we levarage the more
 * advanced positional parameters feature to allow our alias to be passed simple
 * arguments and invoke complex arguments on the actual command.
 * 
 *
 */
public class PositionalAliasedCli {

    public static void main(String[] args) {
        //@formatter:off
        @SuppressWarnings("unchecked")
        // The program name is cli
        CliBuilder builder = Cli.builder("cli")
                                                 // Add a description
                                                 .withDescription("A simple CLI with several commands available")
                                                 // Define some commands
                                                 .withCommand(Simple.class)
                                                 .withCommands(Parent.class, Child.class, GoodGrandchild.class)
                                                 .withCommand(Help.class);
        //@formatter:on

        // Here we define an alias example that invokes the simple command and
        // uses positional parameters. These are a 1 based index of the
        // parameters that a user passes to the alias and allows alias
        // parameters to be constructed into more complex command invocations
        //
        // Syntax is $1
        //
        // If a positional parameter references a parameter that is not provided
        // to the alias the parameter is passed as-is
        //
        // In this example the first parameter that the user passes to the alias
        // is passed as the value of the --name option to the simple command
        //
        // Any additional arguments an alias is invoked will be passed through
        // normally

        //@formatter:off
        builder.withParser()
               .withAlias("example")
               .withArguments("simple", "--name", "$1");
        //@formatter:on

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

}