org.sonar.api.utils.log.LogAndArguments Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation

Plugin API for SonarQube, SonarCloud and SonarLint

There is a newer version: 10.14.0.2599

/*
 * Sonar Plugin API
 * Copyright (C) 2009-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.sonar.api.utils.log;

import java.util.Arrays;
import java.util.Optional;
import javax.annotation.Nullable;

public final class LogAndArguments {
  private final String rawMsg;
  private final Object[] args;
  private final String msg;

  LogAndArguments(String msg, String rawMsg) {
    this.rawMsg = rawMsg;
    this.msg = msg;
    this.args = null;
  }

  LogAndArguments(String msg, String rawMsg, @Nullable Object arg1) {
    this.rawMsg = rawMsg;
    this.args = new Object[] {arg1};
    this.msg = msg;
  }

  LogAndArguments(String msg, String rawMsg, @Nullable Object arg1, @Nullable Object arg2) {
    this.rawMsg = rawMsg;
    this.msg = msg;
    this.args = new Object[] {arg1, arg2};
  }

  LogAndArguments(String msg, String rawMsg, Object... args) {
    this.rawMsg = rawMsg;
    this.msg = msg;
    this.args = args;
  }

  public String getRawMsg() {
    return rawMsg;
  }

  public Optional getArgs() {
    return Optional.ofNullable(args);
  }

  public String getFormattedMsg() {
    return msg;
  }

  @Override
  public String toString() {
    return "LogAndArguments{" +
      "rawMsg='" + rawMsg + '\'' +
      ", args=" + Arrays.toString(args) +
      ", msg='" + msg + '\'' +
      '}';
  }
}