io.hyscale.controller.commands.HyscaleCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of controller-service Show documentation
The newest version!
/**
 * Copyright 2019 Pramati Prism, Inc.
 *
 * 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 io.hyscale.controller.commands;

import java.util.concurrent.Callable;

import io.hyscale.controller.commands.deploy.HyscaleDeployCommand;
import io.hyscale.controller.commands.generate.HyscaleGenerateCommand;
import io.hyscale.controller.commands.get.HyscaleGetCommand;
import io.hyscale.controller.commands.scale.HyscaleScaleCommand;
import io.hyscale.controller.commands.undeploy.HyscaleUndeployCommand;
import org.springframework.stereotype.Component;

import io.hyscale.commons.constants.ToolConstants;
import picocli.CommandLine;
import picocli.CommandLine.Command;

/**
 * This class is the first level command for hyscale tool.
 * This class executes 'hyscale' command
 * 
 * Every command/sub-command has to implement the {@link Callable} so that
 * whenever the command is executed the {@link #call()}
 * method will be invoked
 * 
 * Command annotation overrides the version provider that picoli provides
 * by default, with {@link HyscaleVersionProvider} as implementation
 * 
 * Also check the sub-commands at @Command annotation
 * 
 *
 * @see Command Reference
 */
@Command(name = "hyscale", versionProvider = HyscaleVersionProvider.class, mixinStandardHelpOptions = true, subcommands = {
        HyscaleGetCommand.class, HyscaleDeployCommand.class, HyscaleUndeployCommand.class,
        HyscaleGenerateCommand.class, HyscaleScaleCommand.class})
@Component
public class HyscaleCommand implements Callable {

    /**
     * Executes the hyscale command
     * Provides usage of this command to the user.
     */
    @Override
    public Integer call() throws Exception {
        new CommandLine(this).usage(System.out);
        return ToolConstants.INVALID_INPUT_ERROR_CODE;
    }

}