CommandHelper.java

/*
 * Copyright (c) 2009-present 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.planet57.gshell.internal;

import com.planet57.gshell.command.CommandAction;
import com.planet57.gshell.util.cli2.CliProcessor;
import com.planet57.gshell.util.cli2.Option;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Command helper.
 *
 * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
 * @since 2.0
 */
public class CommandHelper
{
  @Option(name = "h", longName = "help", description = "Display usage", override = true)
  public boolean displayHelp;

  /**
   * Construct a {@link CliProcessor} for given action.
   */
  public CliProcessor createCliProcessor(final CommandAction command) {
    checkNotNull(command);

    CliProcessor clp = new CliProcessor();
    clp.addBean(command);
    clp.addBean(this);

    return clp;
  }
}