org.grails.cli.profile.MultiStepCommand.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grace-shell Show documentation

Grace Framework : Grace Shell

There is a newer version: 2023.1.0-RC1

/*
 * Copyright 2014-2024 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
 *
 *      https://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 org.grails.cli.profile

import org.grails.cli.profile.commands.events.CommandEvents

/**
 * A command that executes multiple steps
 *
 * @author Graeme Rocher
 * @author Michael Yan
 * @since 3.0
 */
abstract class MultiStepCommand implements ProfileCommand, CommandEvents {

    String name
    Profile profile
    boolean visible = true
    boolean deprecated = false
    int minArguments = 1

    MultiStepCommand(String name, Profile profile) {
        this.name = name
        this.profile = profile
    }

    /**
     * @return The steps that make up the command
     */
    abstract List getSteps()

    @Override
    boolean handle(ExecutionContext context) {
        if (minArguments > 0 && (!context.commandLine.getRemainingArgs() || context.commandLine.getRemainingArgs().size() < minArguments)) {
            context.console.error("Expecting ${minArguments ? 'an argument' : minArguments + ' arguments'} to $name.")
            context.console.info("${description.usage}")
            return true
        }
        notify("${name}Start", context)
        for (AbstractStep step : getSteps()) {
            if (!step.handle(context)) {
                break
            }
        }
        notify("${name}End", context)
        true
    }

}