Package org.apache.rat

Class DeprecationReporter

java.lang.Object

org.apache.rat.DeprecationReporter

public final class DeprecationReporter
extends Object

Reporting methods for deprecated objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	DeprecationReporter.Info	Annotation to provide deprecation information for Java8.

Method Summary

Modifier and Type	Method	Description
static Consumer<org.apache.commons.cli.Option>	getDefault()	Get the default reporter.
static Consumer<org.apache.commons.cli.Option>	getLogReporter()	Creates the consumer that will log usage of deprecated operations to the default log.
static void	logDeprecated(Class<?> clazz)	Log Deprecated class use.
static void	logDeprecated(String name, String since, boolean forRemoval, String use)	Log Deprecated class use.
static void	resetLogReporter()	Rests the consumer to the default consumer.
static void	setLogReporter(Consumer<org.apache.commons.cli.Option> consumer)	Sets the consumer that will do the reporting.

Methods inherited from class java.lang.Object

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

Method Details

getDefault

public static Consumer<org.apache.commons.cli.Option> getDefault()

Get the default reporter.

Returns:

The default reporter.

getLogReporter

public static Consumer<org.apache.commons.cli.Option> getLogReporter()

Creates the consumer that will log usage of deprecated operations to the default log.

Returns:

The consumer that will log usage of deprecated operations to the default log.

setLogReporter

public static void setLogReporter(Consumer<org.apache.commons.cli.Option> consumer)

Sets the consumer that will do the reporting.

Parameters:

consumer - The consumer that will do the reporting.

resetLogReporter

public static void resetLogReporter()

Rests the consumer to the default consumer.

logDeprecated

public static void logDeprecated(Class<?> clazz)

Log Deprecated class use.

Parameters:

clazz - the Deprecated class to log

logDeprecated

public static void logDeprecated(String name,
 String since,
 boolean forRemoval,
 String use)

Log Deprecated class use.

Parameters:

name - The name of the deprecated tag

since - The version where the deprecation was declared.

forRemoval - If true then tag is scheduled for removal.

use - What to use instead.