001// Copyright 2004, 2005 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.hivemind;
016
017/**
018 * A wrapper around {@link org.apache.hivemind.ErrorHandler} and
019 * {@link org.apache.commons.logging.Log}for the most common case: reporting recoverable errors.
020 * The point is that most services can use a single property of type ErrorLog, rather than a pair of
021 * properties (ErrorHandler and Log).
022 * 
023 * @author Howard M. Lewis Ship
024 * @since 1.1
025 */
026public interface ErrorLog
027{
028    /**
029     * Invokes {@link ErrorHandler#error(Log, String, Location, Throwable)}.
030     */
031
032    public void error(String message, Location location, Throwable cause);
033}