com.github.rvesse.airline.help.GlobalUsageGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of airline Show documentation

Java library provided an annotation-based framework for parsing Git like command line structures

The newest version!

/**
 * Copyright (C) 2010-16 the original author or authors.
 *
 * 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 com.github.rvesse.airline.help;

import java.io.IOException;
import java.io.OutputStream;

import com.github.rvesse.airline.model.GlobalMetadata;

/**
 * Interface implemented by classes that can generate usage documentation for a
 * command line interface
 */
public interface GlobalUsageGenerator {

    /**
     * Generate the help and output it on standard out
     * 
     * @param global
     *            Global Metadata
     * @throws IOException Thrown if there is a problem generating usage output
     */
    public abstract void usage(GlobalMetadata global) throws IOException;

    /**
     * Generate the help and output it to the stream
     * 
     * @param global
     *            Global metadata
     * @param output
     *            Stream to output to
     * @throws IOException Thrown if there is a problem generating usage output
     */
    public abstract void usage(GlobalMetadata global, OutputStream output) throws IOException;
}