Package eu.bandm.tools.util.files

Class PrintWriter_limited

java.lang.Object

java.io.Writer

java.io.PrintWriter

eu.bandm.tools.util.files.PrintWriter_limited

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

@PropertyDependency("line.separator")
public class PrintWriter_limited
extends PrintWriter

Prints only the n first characters and igores the rest. Useful in debugging for printing the prefix of a structure dump which would otherwise be (ergonomically) too large for the context. (For instance, whole tdom dumps, of which only the head information needs to be readable.) Since needed for interactive use, the os's default encoding is appropriate.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrintWriter_limited.PrintFinished	Signals to a caller that the number of characters to print has been reached.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	count	Internal counter of characters.
protected boolean	fin	Flag that limit has been reached.
static final String	LS	Public cache for the os-dependent line-separator string, as retrieved by System.getProperty("line.separator").
protected final int	maxcount	Limit on characters.

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
PrintWriter_limited(Writer out, int maxcount)	Constructor setting the target of the prints and the limit in character count.

Method Summary

Modifier and Type	Method	Description
void	print(String s)	Print a string, but only the first count characters.
void	println(String s)	Print a string followed by a line feed.
void	reset()	Reset the counter and start counting anew.

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.io.Writer

nullWriter

Methods inherited from class java.lang.Object

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

Field Details

LS

public static final String LS

Public cache for the os-dependent line-separator string, as retrieved by System.getProperty("line.separator").

count

protected int count

Internal counter of characters.

maxcount

protected final int maxcount

Limit on characters.

fin

protected boolean fin

Flag that limit has been reached.

Constructor Details

PrintWriter_limited

public PrintWriter_limited(Writer out,
 int maxcount)

Constructor setting the target of the prints and the limit in character count. Uses the os's default encoding.

Parameters:

out - the underlying print writer

maxcount - the maximum number of characters to print

Method Details

reset

public void reset()

Reset the counter and start counting anew.

print

public void print(String s)
           throws PrintWriter_limited.PrintFinished

Print a string, but only the first count characters. When this limit is reached, throw PrintWriter_limited.PrintFinished. Flush the output after each call.

Overrides:

print in class PrintWriter

Throws:

UncheckedIOException - if the underlying PrintWriter throws an IOException.

PrintWriter_limited.PrintFinished

println

public void println(String s)

Print a string followed by a line feed.

Overrides:

println in class PrintWriter