Command.java

/**
 * Copyright 2013 Cloudera Inc.
 *
 * 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 org.kitesdk.cli;

import java.io.IOException;
import java.util.List;

public interface Command {
  /**
   * Runs this {@code Command}.
   *
   * @return a return code for the process, 0 indicates success.
   * @throws IOException
   */
  int run() throws IOException;

  /**
   * Returns a list of example uses. Lines starting with '#' will not have the
   * executable name added when formatting.
   *
   * @return a list of String examples
   */
  List<String> getExamples();
}