ExitAction.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.commands.standard;

import com.planet57.gshell.command.Command;
import com.planet57.gshell.command.CommandContext;
import com.planet57.gshell.command.CommandActionSupport;
import com.planet57.gshell.util.cli2.Argument;

import javax.annotation.Nonnull;

/**
 * Exit the current shell.
 *
 * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
 * @since 2.5
 */
@Command(name = "exit", description = "Exit the current shell")
public class ExitAction
    extends CommandActionSupport
{
  @Argument(description = "Exit code", token = "CODE")
  private int exitCode = 0;

  @Override
  public Object execute(@Nonnull final CommandContext context) throws Exception {
    log.debug("Exiting w/code: {}", exitCode);

    // Do not call System.exit(), ask the shell to exit instead.
    throw new ExitNotification(exitCode);
  }
}