gnu.mapping
Class CharArrayOutPort

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          gnu.lists.PrintConsumer
              gnu.mapping.OutPort
                  gnu.mapping.CharArrayOutPort

All Implemented Interfaces:

Consumer, Printable, java.io.Closeable, java.io.Flushable, java.lang.Appendable

public class CharArrayOutPort
extends OutPort

Similar to CharArrayWriter.

Field Summary

Fields inherited from class gnu.mapping.OutPort

bout, errLocation, objectFormat, outLocation, printReadable, unregisterRef

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

CharArrayOutPort()

Method Summary

void	close() Do nothing.
protected boolean	closeOnExit() No point in registering this port with a WriterManager.
int	length()
void	reset()
void	setLength(int length)
char[]	toCharArray() Returns the written data as a freshly copied char array.
java.lang.String	toString() Returns the written data as a new String.
java.lang.String	toSubString(int beginIndex) Returns a substring of the written data as a new String.
java.lang.String	toSubString(int beginIndex, int endIndex) Returns a substring of the written data as a new String.
void	writeTo(Consumer out)
void	writeTo(int start, int count, Consumer out)

Methods inherited from class gnu.mapping.OutPort

clearBuffer, closeLogFile, echo, endAttribute, endElement, endLogicalBlock, errDefault, freshLine, getColumnNumber, isWordChar, openFile, outDefault, print, print, print, print, print, print, print, runCleanups, setColumnNumber, setErrDefault, setIndentation, setLogFile, setOutDefault, startAttribute, startElement, startLogicalBlock, startLogicalBlock, writeBreak, writeBreakFill, writeBreakLinear, writeSpaceFill, writeSpaceLinear, writeWordEnd, writeWordStart

Methods inherited from class gnu.lists.PrintConsumer

endDocument, endNumber, ignoring, startDocument, startNumber, write, writeBoolean, writeDouble, writeFloat, writeInt, writeLong, writeObject

Methods inherited from class java.io.PrintWriter

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface gnu.lists.Consumer

write, write, write

Constructor Detail

CharArrayOutPort

public CharArrayOutPort()

Method Detail

length

public int length()

setLength

public void setLength(int length)

reset

public void reset()

toCharArray

public char[] toCharArray()

Returns the written data as a freshly copied char array.

close

public void close()

Do nothing. This allows access to the buffer after the port is closed. Not clear whether this is a good or bad idea, but it matches ByteArrayOutputStream, CharArrayWriter, and StringWriter.

Specified by:

close in interface java.io.Closeable

Overrides:

close in class OutPort

closeOnExit

protected boolean closeOnExit()

No point in registering this port with a WriterManager.

Overrides:

closeOnExit in class OutPort

toString

public java.lang.String toString()

Returns the written data as a new String.

Overrides:

toString in class java.lang.Object

toSubString

public java.lang.String toSubString(int beginIndex,
                                    int endIndex)

Returns a substring of the written data as a new String. Equivalent to toString().substring(beginIndex, endIndex) but more efficient.

toSubString

public java.lang.String toSubString(int beginIndex)

Returns a substring of the written data as a new String. Equivalent to toString().substring(beginIndex) but more efficient.

writeTo

public void writeTo(Consumer out)

writeTo

public void writeTo(int start,
                    int count,
                    Consumer out)