shadow:io

Class TextOutput

Parent class

shadow:standard@Object

Interfaces

shadow:io@CanClose

class TextOutput

Class TextOutput provides methods for writing text data to a CanWrite object. Output operations are buffered for performance a CanWrite object often writes to files or other high-latency devices.

Create Summary

Modifiers Return Types Method and Description
public () create(CanWrite writer)
public () create(CanWrite writer, int size)

Destroy Summary

Modifiers Return Types Method and Description
public () destroy()

Closes the TextOutput on destroy and flushes buffers.

Method Summary

Modifiers Return Types Method and Description
public () close()

Close underlying writer, if possible.

public readonly (TextOutput) copy(AddressMap addresses)
public (TextOutput) flush()
public (TextOutput) write(nullable Object value)

Writes an object's String representation, using the underlying writer.

public (TextOutput) write(String value)

Writes a String value with the underlying writer.

public (TextOutput) writeLine()

Writes new line characters with the underlying writer.

public (TextOutput) writeLine(String value)

Property Summary

Modifiers Return Types Method and Description
public readonly get (String) lineSeparator()

Create Detail

create

public create(CanWrite writer) => ()

create

public create(CanWrite writer, int size) => ()

Destroy Detail

destroy

public destroy() => ()

Closes the TextOutput on destroy and flushes buffers.

Method Detail

close

public close() => ()

Close underlying writer, if possible.

copy

public readonly copy(AddressMap addresses) => (TextOutput)

flush

public flush() => (TextOutput)

write

public write(nullable Object value) => (TextOutput)

Writes an object's String representation, using the underlying writer.

Parameters

value - object to write

Returns

TextOutput object

write

public write(String value) => (TextOutput)

Writes a String value with the underlying writer. This operation is buffered for performance. Output might not occur until a flush() call.

Parameters

value - String to write

Returns

Console object

writeLine

public writeLine() => (TextOutput)

Writes new line characters with the underlying writer. Note that this output is platform dependent.

Returns

TextOutput object

writeLine

public writeLine(String value) => (TextOutput)

Property Detail

lineSeparator

public readonly get lineSeparator() => (String)