You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2002/11/11 11:36:29 UTC
cvs commit: jakarta-avalon-excalibur/meta/src/java/org/apache/excalibur/meta/model Category.java
mcconnell 2002/11/11 02:36:29
Added: meta/src/java/org/apache/excalibur/meta/model Category.java
Log:
Initial commit of the Category class. A category is a description of the
logging priority, and target that a container will assign to a component. The
Categiory class is contained and exposed by the LoggingDirective class.
Revision Changes Path
1.1 jakarta-avalon-excalibur/meta/src/java/org/apache/excalibur/meta/model/Category.java
Index: Category.java
===================================================================
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. 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. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software
* itself, if and wherever such third-party acknowledgments
* normally appear.
*
* 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
* must not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.excalibur.meta.model;
import java.io.Serializable;
/**
* A logging category descriptor hierachy. The descriptor contains a category name, a
* optional priority value, and an optional target. If the priority or target values
* null, the resulting value will be derived from the parent category desciptor. A
* category descriptor may 0-n subsidiary categories. Category names are relative.
* For example, the category "orb" will appear as "my-app.orb" if the parent category
* name is "my-app".
*
* <p><b>XML</b></p>
* <pre>
* <categories priority="<font color="darkred">INFO</font>">
* <category priority="<font color="darkred">DEBUG</font>" name="<font color="darkred">loader</font>" />
* <category priority="<font color="darkred">WARN</font>" name="<font color="darkred">types</font>" />
* <category priority="<font color="darkred">ERROR</font>" name="<font color="darkred">types.builder</font>" target="<font color="darkred">default</font>"/>
* <category name="<font color="darkred">profiles</font>" />
* <category name="<font color="darkred">lifecycle</font>" />
* <category name="<font color="darkred">verifier</font>" />
* </categories>
* </pre>
* @author <a href="mailto:mcconnell@apache.org">Stephen McConnell</a>
* @version $Revision: 1.1 $ $Date: 2002/11/11 10:36:29 $
*/
public class Category implements Serializable
{
/**
* Constant category priority value for debug mode.
*/
public static final String DEBUG = "DEBUG";
/**
* Constant category priority value for info mode.
*/
public static final String INFO = "INFO";
/**
* Constant category priority value for warning mode.
*/
public static final String WARN = "WARN";
/**
* Constant category priority value for error mode.
*/
public static final String ERROR = "ERROR";
/**
* Constant value for the default logging target name.
*/
public static final String DEFAULT_LOGGING_TARGET = "default";
/**
* Constant value for the default logging priority level.
*/
public static final String DEFAULT_LOGGING_PRIORITY = INFO;
/**
* The logging category name.
*/
private String m_name;
/**
* The default logging priority.
*/
private final String m_priority;
/**
* The default logging target.
*/
private final String m_target;
/**
* Creation of a new Category using a supplied name.
*
* @param name the category name
*/
public Category( final String name )
{
this( name, null, null );
}
/**
* Creation of a new Category using a supplied name, priority, target and
* collection of subsidiary categories.
*
* @param name the category name
* @param priority the category priority - DEBUG, INFO, WARN, or ERROR
* @param target the name of a logging category target
*
*/
public Category(
final String name, final String priority, final String target )
{
m_name = name;
m_target = target;
m_priority = priority;
}
/**
* Return the category name.
*
* @return the category name
*/
public String getName()
{
return m_name;
}
/**
* Return the default logging priority for the group of categories.
*
* @return the logging priority for the category
*/
public String getPriority()
{
return m_priority;
}
/**
* Return the default log target for the group of categories.
*
* @return the default target name
*/
public String getTarget()
{
return m_target;
}
}
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>