de.l3s.boilerpipe.filters.debug

Class PrintDebugFilter

java.lang.Object

de.l3s.boilerpipe.filters.debug.PrintDebugFilter

All Implemented Interfaces:

BoilerpipeFilter

public final class PrintDebugFilter
extends Object
implements BoilerpipeFilter

Prints debug information about the current state of the TextDocument. (= calls TextDocument.debugString().

Author:

Christian Kohlschütter

Field Summary

Fields

Modifier and Type	Field and Description
static PrintDebugFilter	INSTANCE Returns the default instance for PrintDebugFilter, which dumps debug information to System.out

Constructor Summary

Constructors

Constructor and Description
PrintDebugFilter(PrintWriter out) Creates a new instance of PrintDebugFilter.

Method Summary

Methods

Modifier and Type	Method and Description
static PrintDebugFilter	getInstance() Returns the default instance for PrintDebugFilter, which dumps debug information to System.out
boolean	process(TextDocument doc) Processes the given document doc.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final PrintDebugFilter INSTANCE

Returns the default instance for PrintDebugFilter, which dumps debug information to System.out

Constructor Detail

PrintDebugFilter

public PrintDebugFilter(PrintWriter out)

Creates a new instance of PrintDebugFilter. Only use this method if you are not going to dump the debug information to System.out -- for this case, use getInstance() instead.

Parameters:

out - The target PrintWriter. Will not be closed

Method Detail

getInstance

public static PrintDebugFilter getInstance()

Returns the default instance for PrintDebugFilter, which dumps debug information to System.out

process

public boolean process(TextDocument doc)
                throws BoilerpipeProcessingException

Description copied from interface: BoilerpipeFilter

Processes the given document doc.

Specified by:

process in interface BoilerpipeFilter

Parameters:

doc - The TextDocument that is to be processed.

Returns:

true if changes have been made to the TextDocument.

Throws:

BoilerpipeProcessingException