io.github.intisy.gradle.github.plugin

Class Logger

java.lang.Object

io.github.intisy.gradle.github.plugin.Logger

All Implemented Interfaces:

GitHubLogger

public class Logger
extends java.lang.Object
implements GitHubLogger

A logger for the GitHub plugin.

Constructor Summary

Constructors

Constructor and Description
Logger(GithubExtension extension) Creates a new logger.
Logger(GithubExtension extension, org.gradle.api.Project project) Creates a new logger.
Logger(org.gradle.api.Project project) Creates a new logger.

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.String message) Logs a debug message.
void	error(java.lang.String message) Logs an error message.
void	error(java.lang.String message, java.lang.Throwable throwable) Logs an error message along with an exception's stack trace.
void	log(java.lang.String message) Logs a standard lifecycle message, visible in the default Gradle output.
void	warn(java.lang.String message) Logs a warning message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Logger

public Logger(GithubExtension extension)

Creates a new logger.

Parameters:

extension - The GitHub extension.

Logger

public Logger(org.gradle.api.Project project)

Creates a new logger.

Parameters:

project - The project.

Logger

public Logger(GithubExtension extension,
              org.gradle.api.Project project)

Creates a new logger.

Parameters:

extension - The GitHub extension.

project - The project.

Method Detail

log

public void log(java.lang.String message)

Logs a standard lifecycle message, visible in the default Gradle output.

Specified by:

log in interface GitHubLogger

Parameters:

message - The message to log.

error

public void error(java.lang.String message)

Logs an error message.

Specified by:

error in interface GitHubLogger

Parameters:

message - The message to log.

error

public void error(java.lang.String message,
                  java.lang.Throwable throwable)

Logs an error message along with an exception's stack trace.

Specified by:

error in interface GitHubLogger

Parameters:

message - The message to log.

throwable - The exception to log.

debug

public void debug(java.lang.String message)

Logs a debug message.

This message will be shown at the LIFECYCLE level (visible by default) only if the user sets `github.debug = true` in their build script, providing an easy way to enable verbose logging for this plugin specifically.

Specified by:

debug in interface GitHubLogger

Parameters:

message - The message to log.

warn

public void warn(java.lang.String message)

Logs a warning message.

Specified by:

warn in interface GitHubLogger

Parameters:

message - The message to log.