• Home
• io.github.ma1uta.matrix
• bot-impl
• 0.13.1
• source code
• Command.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.github.ma1uta.matrix.bot.Command Maven / Gradle / Ivy

/*
 * Copyright Anatoliy Sablin [email protected]
 *
 * 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.github.ma1uta.matrix.bot;

import io.github.ma1uta.matrix.event.RoomEvent;

/**
 * Command interface.
 *
 * @param  actual class of the configuration.
 * @param  bot's dao.
 * @param  bot's service.
 * @param  extra data.
 */
public interface Command, S extends PersistentService, E> {

    /**
     * Command name.
     *
     * @return name.
     */
    String name();

    /**
     * Invoking command.
     *
     * @param context   bot's context.
     * @param roomId    room id.
     * @param event     event with command.
     * @param arguments (without command).
     * @return {@code true} if invoked, else {@code false}.
     */
    boolean invoke(Context context, String roomId, RoomEvent event, String arguments);

    /**
     * Help information.
     *
     * @return help information.
     */
    String help();

    /**
     * Usage information.
     *
     * @return usage information.
     */
    String usage();
}