Reporter.java

/*
 * Copyright 2013-14 Skynav, Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY SKYNAV, INC. AND ITS CONTRIBUTORS “AS IS” AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL SKYNAV, INC. OR ITS CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.skynav.ttv.util;

import java.io.IOException;
import java.io.PrintWriter;
import java.net.URI;
import java.util.ResourceBundle;

import org.xml.sax.Locator;

public interface Reporter {
    public enum ReportType {
        Error,
        Warning,
        Info,
        Debug;
    };
    public String getName();
    public boolean isOpen();
    public void open(Object... arguments) throws IOException;
    public void close() throws IOException;
    public void resetResourceState(boolean restart);
    public void resetAllState(boolean restart);
    public void setResourceURI(String uri);
    public void setResourceURI(URI uri);
    public void setLines(String[] lines);
    public void hidePath();
    public void showPath();
    public boolean isHidingPath();
    public void hideLocation();
    public void showLocation();
    public boolean isHidingLocation();
    public int getResourceErrors();
    public int getResourceWarnings();
    public void setOutput(PrintWriter output);
    public PrintWriter getOutput();
    public void flush();
    public void setBundle(ResourceBundle bundle);
    public ResourceBundle getBundle();
    public void setVerbosityLevel(int level);
    public void incrementVerbosityLevel();
    public int getVerbosityLevel();
    public void setDebugLevel(int level);
    public void incrementDebugLevel();
    public int getDebugLevel();
    public Message message(String key, String format, Object... arguments);
    public Message message(Locator locator, String key, String format, Object... arguments);
    public void logError(Message message);
    public void logError(Exception e);
    public boolean hasDefaultWarning(String token);
    public void addDefaultWarning(String token, boolean enabled);
    public void setTreatWarningAsError(boolean treatWarningAsError);
    public boolean isTreatingWarningAsError();
    public boolean isWarningEnabled(String token);
    public boolean hasEnabledWarning(String token);
    public void enableWarning(String token);
    public boolean hasDisabledWarning(String token);
    public void disableWarning(String token);
    public void disableWarnings();
    public boolean areWarningsDisabled();
    public void hideWarnings();
    public boolean  areWarningsHidden();
    public boolean logWarning(Message message);
    public boolean logWarning(Exception e);
    public void logInfo(Message message);
    public void logDebug(Message message);
}