net.scattersphere.client.handler.CommandHandler Maven / Gradle / Ivy

Go to download
/*
 * Scattersphere
 * Copyright 2014-2015, Scattersphere Project.
 *
 * 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 net.scattersphere.client.handler;

/**
 * This interface is used for commands handled through the CLI.
 *
 * Created by kenji on 12/5/14.
 */
public interface CommandHandler {

    /**
     * Handles a command.
     *
     * @param args The arguments sent.
     */
    void handle(String args[]);

    /**
     * Returns the string that the command supports.
     *
     * @return {@code String} containing the command string supported.
     */
    String getCommandString();

    /**
     * Indicates whether or not the handler can handle the command requested.
     *
     * @param args The arguments sent.
     * @return {@code true} if the command can be processed, {@code false} otherwise.
     */
    default boolean canHandle(String args[]) {
        return args != null && args.length > 0 && args[0].equalsIgnoreCase(getCommandString());
    }

}