AbstractJrbRunnable.java

/**
 * Get more info at : www.jrebirth.org .
 * Copyright JRebirth.org © 2011-2013
 * Contact : sebastien.bordes@jrebirth.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jrebirth.af.core.concurrent;

import java.time.Instant;

import org.jrebirth.af.api.concurrent.JRebirthRunnable;
import org.jrebirth.af.api.concurrent.RunnablePriority;
import org.jrebirth.af.api.exception.JRebirthThreadException;
import org.jrebirth.af.api.log.JRLogger;
import org.jrebirth.af.core.log.JRLoggerFactory;

/**
 * The class <strong>AbstractJrbRunnable</strong>.
 *
 * @author Sébastien Bordes
 */
public abstract class AbstractJrbRunnable implements JRebirthRunnable, ConcurrentMessages {

    /** The class logger. */
    private static final JRLogger LOGGER = JRLoggerFactory.getLogger(AbstractJrbRunnable.class);

    /** This name is used for debug purpose. */
    private final String runnableName;

    /** The runnable priority. */
    private final RunnablePriority priority;

    /** The creation timestamp in milliseconds. */
    private final Instant creationTime;

    /**
     * Default Constructor.
     *
     * @param runnableName the name of the runnable to allow live debugging
     */
    public AbstractJrbRunnable(final String runnableName) {
        this(runnableName, RunnablePriority.Normal);
    }

    /**
     * Default Constructor.
     *
     * @param runnableName the name of the runnable to allow live debugging
     * @param priority the runnable priority
     */
    public AbstractJrbRunnable(final String runnableName, final RunnablePriority priority) {

        this.creationTime = Instant.now();

        this.runnableName = runnableName;
        this.priority = priority;

    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final void run() {

        LOGGER.trace(RUN_IT, this.runnableName);

        try {
            runInto();
        } catch (final JRebirthThreadException jte) {
            LOGGER.error(THREAD_ERROR, jte, jte.getMessage());
        }

    }

    /**
     * Run task and allow to throw a JRebirthException.
     *
     * @throws JRebirthThreadException it thread error
     */
    protected abstract void runInto() throws JRebirthThreadException;

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return "JRebirthRunnable - " + this.runnableName;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public RunnablePriority getPriority() {
        return this.priority;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Instant getCreationTime() {
        return this.creationTime;
    }

}