org.sejda.cli.command.CliCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sejda-console Show documentation

The sejda-console is a shell interface for Sejda to perform pdf manipulation tasks such as merge or split through the command line.

There is a newer version: 3.2.85

Show newest version

/*
 * Created on 14 gen 2017
 * Copyright 2015 by Andrea Vacondio ([email protected]).
 * This file is part of Sejda.
 *
 * Sejda 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.
 *
 * Sejda 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 Sejda.  If not, see .
 */
package org.sejda.cli.command;

import org.sejda.model.parameter.base.TaskParameters;

/**
 * Defines a command line command
 * 
 * @author Andrea Vacondio
 *
 */
public interface CliCommand {
    /**
     * @return the user friendly name
     */
    String getDisplayName();

    /**
     * @return task description, explaining what the task does in a nutshell
     */
    String getDescription();

    /**
     * @return extended task description, explaining what the task does in detail, providing an example
     */
    String getExampleUsage();

    /**
     * @return help message, detailing purpose, usage and parameter valid values
     */
    String getHelpMessage();

    /**
     * @param rawArguments
     * @return task parameters out of the raw string arguments passed as input (removing the command argument for example)
     */
    TaskParameters parseTaskParameters(String[] rawArguments);

    /**
     * @return the argument class for this command
     */
    Class getCliArgumentsClass();
}