com.google.cloud.bigtable.hbase.util.Logger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bigtable-hbase Show documentation
This project contains artifacts that adapt bigtable client to work with hbase.
There is a newer version: 2.14.7
/*
 * Copyright 2020 Google LLC
 *
 * 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 com.google.cloud.bigtable.hbase.util;

import com.google.api.core.InternalApi;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Wrapper around {@link Log} to conditionally format messages if a specified log level is enabled.
 *
 * For internal use only - public for technical reasons.
 */
@InternalApi("For internal usage only")
public class Logger {
  protected final Log log;

  /**
   * Constructor for Logger.
   *
   * @param logClass a {@link Class} object.
   */
  public Logger(Class logClass) {
    this.log = LogFactory.getLog(logClass);
  }

  /**
   * trace
   *
   * @see Log#trace
   * @param message Format string.
   * @param args Arguments for format string.
   */
  public void trace(String message, Object... args) {
    if (log.isTraceEnabled()) {
      log.trace(String.format(message, args));
    }
  }

  /**
   * debug
   *
   * @see Log#debug
   * @param message Format string.
   * @param args Arguments for format string.
   */
  public void debug(String message, Object... args) {
    if (log.isDebugEnabled()) {
      log.debug(String.format(message, args));
    }
  }

  /**
   * debug
   *
   * @see Log#debug
   * @param message Format string.
   * @param t a {@link Throwable} object.
   * @param args Arguments for format string.
   */
  public void debug(String message, Throwable t, Object... args) {
    if (log.isDebugEnabled()) {
      log.debug(String.format(message, args), t);
    }
  }

  /**
   * info
   *
   * @see Log#info
   * @param message Format string.
   * @param args Arguments for format string.
   */
  public void info(String message, Object... args) {
    if (log.isInfoEnabled()) {
      log.info(String.format(message, args));
    }
  }

  /**
   * info
   *
   * @see Log#info
   * @param message Format string.
   * @param t a {@link Throwable} object.
   * @param args Arguments for format string.
   */
  public void info(String message, Throwable t, Object... args) {
    if (log.isInfoEnabled()) {
      log.info(String.format(message, args), t);
    }
  }

  /**
   * warn
   *
   * @see Log#warn
   * @param message Format string.
   * @param args Arguments for format string.
   */
  public void warn(String message, Object... args) {
    if (log.isWarnEnabled()) {
      log.warn(String.format(message, args));
    }
  }

  /**
   * warn
   *
   * @see Log#warn
   * @param message Format string.
   * @param t a {@link Throwable} object.
   * @param args Arguments for format string.
   */
  public void warn(String message, Throwable t, Object... args) {
    if (log.isWarnEnabled()) {
      log.warn(String.format(message, args), t);
    }
  }

  /**
   * error
   *
   * @see Log#error
   * @param message Format string.
   * @param args Arguments for format string.
   */
  public void error(String message, Object... args) {
    if (log.isErrorEnabled()) {
      log.error(String.format(message, args));
    }
  }

  /**
   * error
   *
   * @see Log#error
   * @param message Format string.
   * @param t a {@link Throwable} object.
   * @param args Arguments for format string.
   */
  public void error(String message, Throwable t, Object... args) {
    if (log.isErrorEnabled()) {
      log.error(String.format(message, args), t);
    }
  }

  /**
   * fatal
   *
   * @see Log#fatal
   * @param message a {@link String} object.
   * @param args a {@link Object} object.
   */
  public void fatal(String message, Object... args) {
    if (log.isFatalEnabled()) {
      log.fatal(String.format(message, args));
    }
  }

  /**
   * fatal
   *
   * @see Log#fatal
   * @param message Format string.
   * @param t a {@link Throwable} object.
   * @param args Arguments for format string.
   */
  public void fatal(String message, Throwable t, Object... args) {
    if (log.isFatalEnabled()) {
      log.fatal(String.format(message, args), t);
    }
  }

  /** Get the underlying {@link Log} */
  public Log getLog() {
    return log;
  }
}