cz.hobrasoft.pdfmu

Class TextOutput

java.lang.Object

cz.hobrasoft.pdfmu.TextOutput

All Implemented Interfaces:

Flushable

public class TextOutput
extends Object
implements Flushable

Prints indented messages to a PrintStream

The indentation level starts at 0 and can be changed using indentMore() and indentLess().

Example of usage:

 
 TextOutput to = new TextOutput(System.out);
 to.println("Hello!");
 to.indentMore("My favorite fruits:");
 to.println("Banana");
 to.println("Apple");
 to.indentLess();
 to.flush();
 
 

Author:

Filip Bartek

Constructor Summary

Constructors

Constructor and Description
TextOutput() Creates a TextOutput that discards all the messages
TextOutput(PrintStream ps) Creates a TextOutput bound to a PrintStream

Method Summary

Modifier and Type	Method and Description
void	flush() Flushes the underlying PrintStream
void	indentLess() Decrements the indentation level
void	indentMore() Increments the indentation level
void	indentMore(String message) Prints a message and increments the indentation level
void	println(String x) Prints a message on a separate line

Methods inherited from class java.lang.Object

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

Constructor Detail

TextOutput

public TextOutput(PrintStream ps)

Creates a TextOutput bound to a PrintStream

Parameters:

ps - the PrintStream to print messages to

TextOutput

public TextOutput()

Creates a TextOutput that discards all the messages

Method Detail

println

public void println(String x)

Prints a message on a separate line

The message is indented by the current indentation level (starting at 0) and printed using the specified PrintStream.

Mimics PrintStream.println(String x).

Parameters:

x - message to print

indentMore

public void indentMore()

Increments the indentation level

If the code between indentMore() and indentLess() may throw a (checked) exception, surround the code with a try-finally block like this to maintain consistency:

 
 TextOutput to;
 to.indentMore();
 try {
   // Do stuff, possibly throwing an exception
 // Possibly catch the exception
 } finally {
   to.indentLess();
 }
 
 

indentMore

public void indentMore(String message)

Prints a message and increments the indentation level

Parameters:

message - message to print

indentLess

public void indentLess()

Decrements the indentation level

flush

public void flush()
           throws IOException

Flushes the underlying PrintStream

Specified by:

flush in interface Flushable

Throws:

IOException - if the underlying PrintStream.flush() throws an IOException