com.greenpepper.report.Report Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of greenpepper-remote-agent Show documentation
The newest version!
/*
 * Copyright (c) 2006 Pyxis Technologies inc.
 *
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This software 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA,
 * or see the FSF site: http://www.fsf.org.
 */
package com.greenpepper.report;

import com.greenpepper.document.Document;

import java.io.IOException;
import java.io.Writer;

/**
 * Interface for formating test results.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
public interface Report
{
    /**
     * getName.
     *
     * @return a {@link java.lang.String} object.
     */
    String getName();

    /**
     * getType.
     *
     * @return a {@link java.lang.String} object.
     */
    String getType();

    /**
     * Adds a test result as a string to this OutputFormat.
     *
     * @param out a {@link java.io.Writer} object.
     * @throws java.io.IOException if any.
     */
    void printTo( Writer out ) throws IOException;

    /**
     * renderException.
     *
     * @param t a {@link java.lang.Throwable} object.
     */
    void renderException( Throwable t );

    //
    /**
     * generate.
     *
     * @param doc a {@link com.greenpepper.document.Document} object.
     */
    void generate( Document doc );

    /**
     * getDocumentUri.
     *
     * @return a {@link java.lang.String} object.
     */
    String getDocumentUri();
}