org.sonarsource.sonarlint.core.commons.log.SonarLintLogger Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sonarlint-core Show documentation
Common library used by some SonarLint flavors
There is a newer version: 10.1.0.77731
/*
 * SonarLint Commons
 * Copyright (C) 2016-2022 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonarsource.sonarlint.core.commons.log;

import javax.annotation.Nullable;
import org.sonarsource.sonarlint.core.commons.log.ClientLogOutput.Level;

/**
 * This is the logging facade to be used in SonarLint core.
 *
 */
public class SonarLintLogger {
  private static final SonarLintLogger logger = new SonarLintLogger(new LogOutputDelegator());
  private final LogOutputDelegator logOutput;

  public static SonarLintLogger get() {
    return logger;
  }

  public static void setTarget(@Nullable ClientLogOutput output) {
    logger.logOutput.setTarget(output);
  }

  SonarLintLogger(LogOutputDelegator logOutput) {
    this.logOutput = logOutput;
  }

  public void debug(String msg) {
    logOutput.log(msg, Level.DEBUG);
  }

  public void debug(String msg, Object arg) {
    doLogExtractingThrowable(Level.DEBUG, msg, new Object[] {arg});
  }

  public void debug(String msg, Object arg1, Object arg2) {
    doLogExtractingThrowable(Level.DEBUG, msg, new Object[] {arg1, arg2});
  }

  public void debug(String msg, Object... args) {
    doLogExtractingThrowable(Level.DEBUG, msg, args);
  }

  public void info(String msg) {
    logOutput.log(msg, Level.INFO);
  }

  public void info(String msg, Object arg) {
    doLogExtractingThrowable(Level.INFO, msg, new Object[] {arg});
  }

  public void info(String msg, Object arg1, Object arg2) {
    doLogExtractingThrowable(Level.INFO, msg, new Object[] {arg1, arg2});
  }

  public void info(String msg, Object... args) {
    doLogExtractingThrowable(Level.INFO, msg, args);
  }

  public void warn(String msg) {
    logOutput.log(msg, Level.WARN);
  }

  public void warn(String msg, Throwable thrown) {
    logOutput.log(msg, Level.WARN, thrown);
  }

  public void warn(String msg, Object arg) {
    doLogExtractingThrowable(Level.WARN, msg, new Object[] {arg});
  }

  public void warn(String msg, Object arg1, Object arg2) {
    doLogExtractingThrowable(Level.WARN, msg, new Object[] {arg1, arg2});
  }

  public void warn(String msg, Object... args) {
    doLogExtractingThrowable(Level.WARN, msg, args);
  }

  public void error(String msg) {
    logOutput.log(msg, Level.ERROR);
  }

  public void error(String msg, Object arg) {
    doLogExtractingThrowable(Level.ERROR, msg, new Object[] {arg});
  }

  public void error(String msg, Object arg1, Object arg2) {
    doLogExtractingThrowable(Level.ERROR, msg, new Object[] {arg1, arg2});
  }

  public void error(String msg, Object... args) {
    doLogExtractingThrowable(Level.ERROR, msg, args);
  }

  public void error(String msg, Throwable thrown) {
    logOutput.log(msg, Level.ERROR, thrown);
  }

  private void doLogExtractingThrowable(Level level, String msg, Object[] argArray) {
    var tuple = MessageFormatter.arrayFormat(msg, argArray);
    logOutput.log(tuple.getMessage(), level, tuple.getThrowable());
  }

}