org.apache.reef.util.logging.LoggingScopeImpl.java Source code

Introduction

Here is the source code for org.apache.reef.util.logging.LoggingScopeImpl.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.reef.util.logging;

import org.apache.commons.lang3.time.StopWatch;
import org.apache.reef.util.Optional;

import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Log time and duration for a scope.
 */
public class LoggingScopeImpl implements LoggingScope {
    public static final String TOKEN = ":::";
    public static final String START_PREFIX = "START" + TOKEN;
    public static final String EXIT_PREFIX = "EXIT" + TOKEN;
    public static final String DURATION = " Duration = ";

    private final StopWatch stopWatch = new StopWatch();

    private final Logger logger;

    private final String msg;

    private final Object[] params;

    private final Optional<Object[]> optionalParams;

    private final Level logLevel;

    /**
     * A constructor of ReefLoggingScope. It starts the timer and logs the msg
     *
     * @param logger
     * @param msg
     * @param params
     */
    LoggingScopeImpl(final Logger logger, final Level logLevel, final String msg, final Object[] params) {
        this.logger = logger;
        this.logLevel = logLevel;
        this.msg = msg;
        this.params = params;
        stopWatch.start();
        this.optionalParams = Optional.ofNullable(params);

        if (logger.isLoggable(logLevel)) {
            final StringBuilder sb = new StringBuilder();
            log(sb.append(START_PREFIX).append(msg).toString());
        }
    }

    /**
     * A constructor of ReefLoggingScope.  It starts the timer and and logs the msg.
     *
     * @param logger
     * @param msg
     */
    LoggingScopeImpl(final Logger logger, final Level logLevel, final String msg) {
        this(logger, logLevel, msg, null);
    }

    /**
     * The close() will be called when the object is to deleted. It stops the timer and logs the time elapsed.
     */
    @Override
    public void close() {
        stopWatch.stop();

        if (logger.isLoggable(logLevel)) {
            final StringBuilder sb = new StringBuilder();
            log(sb.append(EXIT_PREFIX).append(msg).append(DURATION).append(stopWatch.getTime()).toString());
        }
    }

    /**
     * Log message.
     * @param message
     */
    private void log(final String message) {
        if (this.optionalParams.isPresent()) {
            logger.log(logLevel, message, params);
        } else {
            logger.log(logLevel, message);
        }
    }
}