Module io.sf.carte.util

Package io.sf.carte.util

Interface SimpleWriter

All Superinterfaces:

Appendable

All Known Implementing Classes:

BufferSimpleWriter, DefaultSimpleWriter

public interface SimpleWriter
extends Appendable

A simple writer interface.

Similar to a subset from Writer, but with newLine() method added, similar to BufferedWriter.newLine() but with the difference that the newline not necessarily uses the line.separator system property and instead may target another system.

Method Summary

Modifier and Type	Method	Description
default SimpleWriter	append(char c)
default SimpleWriter	append(CharSequence csq)
default SimpleWriter	append(CharSequence csq, int start, int end)
default char	getLastChar()	Get the last character processed.
void	newLine()	Write a newline according to the characteristics of the target platform.
default void	unwrite()	Remove the last character found in this buffer, if any.
default void	unwrite(int numChars)	Remove the last numChars characters found in this buffer.
void	write(char c)	Write a character.
void	write(char[] cbuf, int off, int len)	Write a sequence of characters from an array.
default void	write(int num)	Write an integer.
void	write(CharSequence seq)	Write a character sequence.

Method Details

newLine

void newLine()
      throws IOException

Write a newline according to the characteristics of the target platform.

Throws:

IOException - if an error happens when writing.

write

void write(CharSequence seq)
    throws IOException

Write a character sequence.

Parameters:

seq - the CharSequence.

Throws:

IOException - if an error happens when writing.

append

default SimpleWriter append(CharSequence csq)
                     throws IOException

Specified by:

append in interface Appendable

Throws:

IOException

append

default SimpleWriter append(CharSequence csq,
 int start,
 int end)
                     throws IOException

Specified by:

append in interface Appendable

Throws:

IOException

write

void write(char[] cbuf,
 int off,
 int len)
    throws IOException

Write a sequence of characters from an array.

Parameters:

cbuf - the character array.

off - the offset to start writing.

len - the number of characters to write from the array.

Throws:

IOException - if an error happens when writing.

write

void write(char c)
    throws IOException

Write a character.

Parameters:

c - the character.

Throws:

IOException - if an error happens when writing.

append

default SimpleWriter append(char c)
                     throws IOException

Specified by:

append in interface Appendable

Throws:

IOException

write

default void write(int num)
            throws IOException

Write an integer.

Parameters:

num - the integer number.

Throws:

IOException - if an error happens when writing.

unwrite

default void unwrite()
              throws UnsupportedOperationException

Remove the last character found in this buffer, if any.

Optional operation.

Throws:

UnsupportedOperationException - if the operation is not supported.

unwrite

default void unwrite(int numChars)
              throws UnsupportedOperationException

Remove the last numChars characters found in this buffer.

If numChars is larger than the length of this buffer, removes all its contents.

Parameters:

numChars - the number of characters to remove.

Throws:

UnsupportedOperationException - if the operation is not supported.

getLastChar

default char getLastChar()
                  throws UnsupportedOperationException,
IllegalStateException

Get the last character processed.

Optional operation.

Returns:

the last character processed.

Throws:

UnsupportedOperationException - if the operation is not supported.

IllegalStateException - if no character was processed yet.