Package com.atlassian.jira.cloud.jenkins.logging

Class PipelineLogger

java.lang.Object

com.atlassian.jira.cloud.jenkins.logging.PipelineLogger

public class PipelineLogger
extends Object

A logger that logs output into the Jenkins pipeline logs. A Jenkins user can view these logs during or after a pipeline run to analyze any potential errors.

Constructor Summary

Constructors

Constructor	Description
PipelineLogger(PrintStream taskLogger, boolean debugLogging)

Method Summary

Modifier and Type	Method	Description
void	debug(String message)
void	error(String message)
void	info(String message)
static PipelineLogger	noopInstance()
void	warn(String message)
void	warn(String message, Exception e)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PipelineLogger

public PipelineLogger(PrintStream taskLogger,
 boolean debugLogging)

Parameters:

taskLogger - a PrintStream that points to the Jenkins pipeline logs. See TaskListener.getLogger().

Method Details

noopInstance

public static PipelineLogger noopInstance()

warn

public void warn(String message)

warn

public void warn(String message,
 Exception e)

info

public void info(String message)

error

public void error(String message)

debug

public void debug(String message)