added javadoc for sonia.scm.logging package

This commit is contained in:
Sebastian Sdorra
2011-07-05 21:54:07 +02:00
parent 88f48ac077
commit 59e11dfca6
2 changed files with 42 additions and 3 deletions

View File

@@ -43,7 +43,9 @@ import java.io.IOException;
import java.io.OutputStream;
/**
* An OutputStream that flushes out to a Logger.
* Based on LoggingOutputStream by Jim Moore
*
* @author Sebastian Sdorra
*/
public class LoggingOutputStream extends OutputStream
@@ -72,10 +74,10 @@ public class LoggingOutputStream extends OutputStream
//~--- constructors ---------------------------------------------------------
/**
* Creates the LoggingOutputStream to flush to the given Category.
* Creates the LoggingOutputStream to flush to the given Logger.
*
* @param logger the Logger to write to
* @param level the Level to use when writing to the Logger
* @param logger - the Logger to write to
* @param level - the Level to use when writing to the Logger
* @throws IllegalArgumentException if cat == null or priority ==
* null
*/

View File

@@ -0,0 +1,37 @@
/**
* Copyright (c) 2010, Sebastian Sdorra
* 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.
* 3. Neither the name of SCM-Manager; nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE REGENTS OR 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.
*
* http://bitbucket.org/sdorra/scm-manager
*
*/
/**
* Logging utilities for the SCM-Manager.
*/
package sonia.scm.logging;