org.inxar.syntacs.util
Interface Channel


public interface Channel

A Channel is a buffered writing device for a Log.


Method Summary
 Channel back()
          Decrements an indent which is manifested after successive newlines.
 void out()
          Writes a newline, flushes the buffer contents, and resets the stream.
 Channel over()
          Increments an indent which is manifested after successive newlines.
 Channel quote(Object msg)
          Writes a message enclosed in double quotations.
 Channel spc()
          Writes a single space.
 Channel stripe(char c, int n)
          Writes the given char n number of times.
 void time()
          The time() method is functionally similar to the out() method; the contents of the buffer are flushed to the parent Log.
 void touch()
          The touch() method is useful for stopping a timed Channel but not writing anything to it.
 Channel write(boolean msg)
          Writes a boolean.
 Channel write(char msg)
          Writes a char.
 Channel write(int msg)
          Writes an int.
 Channel write(Object msg)
          Writes an Object.
 Channel write(String msg)
          Writes a String.
 Channel writeln()
          Writes a newline character.
 

Method Detail

write

public Channel write(Object msg)
Writes an Object.

write

public Channel write(boolean msg)
Writes a boolean.

write

public Channel write(char msg)
Writes a char.

write

public Channel write(int msg)
Writes an int.

write

public Channel write(String msg)
Writes a String.

spc

public Channel spc()
Writes a single space.

quote

public Channel quote(Object msg)
Writes a message enclosed in double quotations.

stripe

public Channel stripe(char c,
                      int n)
Writes the given char n number of times.

writeln

public Channel writeln()
Writes a newline character.

over

public Channel over()
Increments an indent which is manifested after successive newlines.

back

public Channel back()
Decrements an indent which is manifested after successive newlines.

time

public void time()
The time() method is functionally similar to the out() method; the contents of the buffer are flushed to the parent Log. However, a timer is started which runs until the next use of the Channel, at which point the elapsed time is printed to the Log.

touch

public void touch()
The touch() method is useful for stopping a timed Channel but not writing anything to it. Often, time() and touch() invocations come in pairs.

out

public void out()
Writes a newline, flushes the buffer contents, and resets the stream.