123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137 |
- /*
- * Copyright (c) 2006-2011 DMDirc Developers
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
- package com.dmdirc.commandparser.commands;
-
- import com.dmdirc.FrameContainer;
- import com.dmdirc.commandparser.CommandArguments;
- import com.dmdirc.commandparser.CommandManager;
- import com.dmdirc.commandparser.commands.context.CommandContext;
- import com.dmdirc.ui.messages.Styliser;
-
- /**
- * Represents a generic command.
- */
- public abstract class Command {
-
- /** The format name used for command output. */
- protected static final String FORMAT_OUTPUT = "commandOutput";
-
- /** The format name used for command errors. */
- protected static final String FORMAT_ERROR = "commandError";
-
- /**
- * Sends a line, if appropriate, to the specified target.
- * @param target The command window to send the line to
- * @param isSilent Whether this command is being silenced or not
- * @param type The type of message to send
- * @param args The arguments of the message
- */
- protected final void sendLine(final FrameContainer target,
- final boolean isSilent, final String type, final Object ... args) {
- if (!isSilent && target != null) {
- target.addLine(type, args);
- }
- }
-
- /**
- * Sends a usage line, if appropriate, to the specified target.
- *
- * @param target The command window to send the line to
- * @param isSilent Whether this command is being silenced or not
- * @param name The name of the command that's raising the error
- * @param args The arguments that the command accepts or expects
- */
- protected final void showUsage(final FrameContainer target,
- final boolean isSilent, final String name, final String args) {
- sendLine(target, isSilent, "commandUsage",
- CommandManager.getCommandManager().getCommandChar(),
- name, args);
- }
-
- /**
- * Formats the specified data into a table suitable for output in the
- * textpane. It is expected that each String[] in data has the same number
- * of elements as the headers array.
- *
- * @param headers The headers of the table.
- * @param data The contents of the table.
- * @return A string containing an ASCII table
- */
- protected static String doTable(final String[] headers, final String[][] data) {
- final StringBuilder res = new StringBuilder();
- res.append(Styliser.CODE_FIXED);
- res.append(Styliser.CODE_BOLD);
-
- final int[] maxsizes = new int[headers.length];
-
- for (int i = 0; i < headers.length; i++) {
- maxsizes[i] = headers[i].length() + 3;
-
- for (String[] row : data) {
- maxsizes[i] = Math.max(maxsizes[i], row[i].length() + 3);
- }
-
- doPadding(res, headers[i], maxsizes[i]);
- }
-
- for (String[] source : data) {
- res.append('\n');
- res.append(Styliser.CODE_FIXED);
-
- for (int i = 0; i < source.length; i++) {
- doPadding(res, source[i], maxsizes[i]);
- }
- }
-
- return res.toString();
- }
-
- /**
- * Adds the specified data to the stringbuilder, padding with spaces to
- * the specified size.
- *
- * @param builder The stringbuilder to append data to
- * @param data The data to be added
- * @param size The minimum size that should be used
- */
- private static void doPadding(final StringBuilder builder, final String data,
- final int size) {
- builder.append(data);
-
- for (int i = 0; i < size - data.length(); i++) {
- builder.append(' ');
- }
- }
-
- /**
- * Executes this command.
- *
- * @param origin The container which received the command
- * @param args Arguments passed to this command
- * @param context The context the command was executed in
- * @since 0.6.4
- */
- public abstract void execute(FrameContainer origin,
- CommandArguments args, CommandContext context);
-
- }
|