org.vx68k.bitbucket.api.client.cli.Command Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bitbucket-api-client-cli Show documentation

This project builds an experimental CLI for the Client API.

There is a newer version: 5.0.0

Show newest version

/*
 * Command.java - interface Command
 * Copyright (C) 2018 Kaz Nishimura
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 *
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

package org.vx68k.bitbucket.api.client.cli;

/**
 * Interface for commands.
 *
 * @author Kaz Nishimura
 * @since 5.0
 */
public interface Command
{
    /**
     * Runs the command.
     *
     * @param name invocation name of the command
     * @param args command arguments
     */
    void run(String name, String[] args);

    /**
     * Returns the description of the command.
     * This method is used to make a list of commands.
     * The default implementation returns {@code "(undocumented)"}.
     *
     * @return description of the command
     */
    default String getDescription()
    {
        return "(undocumented)";
    }
}