org.cubeengine.logscribe.LogTarget Maven / Gradle / Ivy

Go to download
/*
 * The MIT License
 * Copyright © 2013 Cube Island
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.cubeengine.logscribe;

/**
 * A Target to publish LogEntries
 */
public abstract class LogTarget extends Filterable
{
    private volatile boolean isShutdown = false;

    /**
     * Shuts down this LogTarget
     */
    public synchronized void shutdown()
    {
        if (!isShutdown)
        {
            this.isShutdown = true;
            this.onShutdown();
        }
    }

    @Override
    public synchronized void log(LogEntry entry)
    {
        if (this.isShutdown)
        {
            return;
        }
        super.log(entry);
    }

    /**
     * Actual Shutdown Method
     * Implement as appropriate for the LogTarget
     */
    protected abstract void onShutdown();

    public boolean isShutdown()
    {
        return this.isShutdown;
    }
}