org.jomc.logging.ri.jdk.JdkLogger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jomc-logging-jdk-logging Show documentation
Object management and configuration logging system implementation backed by JDK Logging.
The newest version!
// SECTION-START[License Header]
// 
/*
 *   Java Object Management and Configuration
 *   Copyright (C) Christian Schulte, 2005-206
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     o Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 *     o 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 "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 AUTHORS OR COPYRIGHT HOLDERS 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.
 *
 *   $JOMC: JdkLogger.java 4808 2013-09-25 17:50:53Z schulte $
 *
 */
// 
// SECTION-END
package org.jomc.logging.ri.jdk;

import java.util.logging.Level;

// SECTION-START[Documentation]
// 
/**
 * Object management and configuration logging system implementation backed by JDK Logging.
 *
 * 
 *   Identifier:
org.jomc.logging.ri.jdk.JdkLogger
 *   Name:
JOMC Logging ⁑ JDK Logging
 *   Specifications:
 *     org.jomc.logging.Logger @ 1.1
 *     org.jomc.spi.Listener @ 1.0
 *   Abstract:
No
 *   Final:
No
 *   Stateless:
Yes
 * 
 *
 * @author Christian Schulte 1.0
 * @version 1.3
 */
// 
// SECTION-END
// SECTION-START[Annotations]
// 
@javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.5", comments = "See http://www.jomc.org/jomc/1.5/jomc-tools-1.5" )
// 
// SECTION-END
public final class JdkLogger
    implements
    org.jomc.logging.Logger,
    org.jomc.spi.Listener
{
    // SECTION-START[Constructors]
    // 
    /** Creates a new {@code JdkLogger} instance. */
    @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.5", comments = "See http://www.jomc.org/jomc/1.5/jomc-tools-1.5" )
    public JdkLogger()
    {
        // SECTION-START[Default Constructor]
        super();
        // SECTION-END
    }
    // 
    // SECTION-END
    // SECTION-START[Logger]

    public boolean isConfigEnabled()
    {
        return this.getLogger().isLoggable( Level.CONFIG );
    }

    public void config( final String message )
    {
        this.log( Level.CONFIG, message, null );
    }

    public void config( final Throwable throwable )
    {
        this.log( Level.CONFIG, throwable.getMessage(), throwable );
    }

    public void config( final String message, final Throwable throwable )
    {
        this.log( Level.CONFIG, message, throwable );
    }

    public boolean isDebugEnabled()
    {
        return this.getLogger().isLoggable( Level.FINE );
    }

    public void debug( final String message )
    {
        this.log( Level.FINE, message, null );
    }

    public void debug( final Throwable throwable )
    {
        this.log( Level.FINE, throwable.getMessage(), throwable );
    }

    public void debug( final String message, final Throwable throwable )
    {
        this.log( Level.FINE, message, throwable );
    }

    public boolean isErrorEnabled()
    {
        return this.getLogger().isLoggable( Level.SEVERE );
    }

    public void error( final String message )
    {
        this.log( Level.SEVERE, message, null );
    }

    public void error( final Throwable throwable )
    {
        this.log( Level.SEVERE, throwable.getMessage(), throwable );
    }

    public void error( final String message, final Throwable throwable )
    {
        this.log( Level.SEVERE, message, throwable );
    }

    public boolean isFatalEnabled()
    {
        return this.getLogger().isLoggable( Level.SEVERE );
    }

    public void fatal( final String message )
    {
        this.log( Level.SEVERE, message, null );
    }

    public void fatal( final Throwable throwable )
    {
        this.log( Level.SEVERE, throwable.getMessage(), throwable );
    }

    public void fatal( final String message, final Throwable throwable )
    {
        this.log( Level.SEVERE, message, throwable );
    }

    public boolean isInfoEnabled()
    {
        return this.getLogger().isLoggable( Level.INFO );
    }

    public void info( final String message )
    {
        this.log( Level.INFO, message, null );
    }

    public void info( final Throwable throwable )
    {
        this.log( Level.INFO, throwable.getMessage(), throwable );
    }

    public void info( final String message, final Throwable throwable )
    {
        this.log( Level.INFO, message, throwable );
    }

    public boolean isTraceEnabled()
    {
        return this.getLogger().isLoggable( Level.FINEST );
    }

    public void trace( final String message )
    {
        this.log( Level.FINEST, message, null );
    }

    public void trace( final Throwable throwable )
    {
        this.log( Level.FINEST, throwable.getMessage(), throwable );
    }

    public void trace( final String message, final Throwable throwable )
    {
        this.log( Level.FINEST, message, throwable );
    }

    public boolean isWarnEnabled()
    {
        return this.getLogger().isLoggable( Level.WARNING );
    }

    public void warn( final String message )
    {
        this.log( Level.WARNING, message, null );
    }

    public void warn( final Throwable throwable )
    {
        this.log( Level.WARNING, throwable.getMessage(), throwable );
    }

    public void warn( final String message, final Throwable throwable )
    {
        this.log( Level.WARNING, message, throwable );
    }

    // SECTION-END
    // SECTION-START[Listener]
    public void onLog( final Level level, final String message, final Throwable throwable )
    {
        if ( level != null )
        {
            if ( level.intValue() <= Level.FINEST.intValue() )
            {
                this.getObjectManagementLogger().trace( message, throwable );
            }
            else if ( level.intValue() <= Level.FINER.intValue() )
            {
                this.getObjectManagementLogger().debug( message, throwable );
            }
            else if ( level.intValue() <= Level.FINE.intValue() )
            {
                this.getObjectManagementLogger().debug( message, throwable );
            }
            else if ( level.intValue() <= Level.CONFIG.intValue() )
            {
                this.getObjectManagementLogger().config( message, throwable );
            }
            else if ( level.intValue() <= Level.INFO.intValue() )
            {
                this.getObjectManagementLogger().info( message, throwable );
            }
            else if ( level.intValue() <= Level.WARNING.intValue() )
            {
                this.getObjectManagementLogger().warn( message, throwable );
            }
            else if ( level.intValue() <= Level.SEVERE.intValue() )
            {
                this.getObjectManagementLogger().error( message, throwable );
            }
            else if ( level.intValue() < Level.OFF.intValue() )
            {
                this.getObjectManagementLogger().fatal( message, throwable );
            }
        }
    }
    // SECTION-END
    // SECTION-START[JdkLogger]

    /**
     * Gets the JDK logger backing the instance.
     *
     * @return The JDK logger backing the instance.
     *
     * @see #getName()
     * @see java.util.logging.Logger#getLogger(java.lang.String)
     */
    public java.util.logging.Logger getLogger()
    {
        return java.util.logging.Logger.getLogger( this.getName() );
    }

    private void log( final Level level, final String msg, final Throwable t )
    {
        if ( this.getLogger().isLoggable( level ) )
        {
            StackTraceElement caller;
            final Throwable x = new Throwable();
            final StackTraceElement[] elements = x.getStackTrace();

            String cname = "unknown";
            String method = "unknown";

            if ( elements != null && elements.length >= this.getStackDepth() )
            {
                caller = elements[this.getStackDepth()];
                cname = caller.getClassName();
                method = caller.getMethodName();
            }

            if ( t == null )
            {
                this.getLogger().logp( level, cname, method, msg );
            }
            else
            {
                this.getLogger().logp( level, cname, method, msg, t );
            }
        }
    }

    // SECTION-END
    // SECTION-START[Dependencies]
    // 
    /**
     * Gets the {@code } dependency.
     * 
     *   This method returns the {@code } object of the {@code } specification at specification level 1.1.
     *   That specification does not apply to any scope. A new object is returned whenever requested and bound to this instance.
     * 
     * Properties:
     *   
     *     
     *       
     *       
     *       
     *     
     *     
     *       
     *       
     *       
     *     
     *     
     *       
     *       
     *       
     *     
     *   Name Type Documentation
{@code } {@code java.lang.String} Name of the logger object management events are logged with.
{@code } {@code int} 
     * 
     * 
     *   Final:
No
     * 
     * @return Logger object management events are logged with.
     * @throws org.jomc.ObjectManagementException if getting the dependency instance fails.
     */
    @SuppressWarnings("unused")
    @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.5", comments = "See http://www.jomc.org/jomc/1.5/jomc-tools-1.5" )
    private org.jomc.logging.Logger getObjectManagementLogger()
    {
        final org.jomc.logging.Logger _d = (org.jomc.logging.Logger) org.jomc.ObjectManagerFactory.getObjectManager( this.getClass().getClassLoader() ).getDependency( this, "ObjectManagementLogger" );
        assert _d != null : "'ObjectManagementLogger' dependency not found.";
        return _d;
    }
    // 
    // SECTION-END
    // SECTION-START[Properties]
    // 
    /**
     * Gets the value of the {@code } property.
     * 

     *   Final:
No
     * 

     * @return Name of the component events are logged for.
     * @throws org.jomc.ObjectManagementException if getting the property instance fails.
     */
    @SuppressWarnings("unused")
    @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.5", comments = "See http://www.jomc.org/jomc/1.5/jomc-tools-1.5" )
    public java.lang.String getName()
    {
        final java.lang.String _p = (java.lang.String) org.jomc.ObjectManagerFactory.getObjectManager( this.getClass().getClassLoader() ).getProperty( this, "name" );
        assert _p != null : "'name' property not found.";
        return _p;
    }
    /**
     * Gets the value of the {@code } property.
     * 

     *   Final:
No
     * 

     * @return Number of frames between the logger and the frame of the caller.
     * @throws org.jomc.ObjectManagementException if getting the property instance fails.
     */
    @SuppressWarnings("unused")
    @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.5", comments = "See http://www.jomc.org/jomc/1.5/jomc-tools-1.5" )
    private int getStackDepth()
    {
        final java.lang.Integer _p = (java.lang.Integer) org.jomc.ObjectManagerFactory.getObjectManager( this.getClass().getClassLoader() ).getProperty( this, "stackDepth" );
        assert _p != null : "'stackDepth' property not found.";
        return _p.intValue();
    }
    // 
    // SECTION-END
    // SECTION-START[Messages]
    // SECTION-END
}
Name	Type	Documentation
{@code }	{@code java.lang.String}	Name of the logger object management events are logged with.
{@code }	{@code int}