Class FileWriter

• Object
  • dw.io.Writer
    • dw.io.FileWriter

Convenience class for writing character files.

Files are stored in a shared file system where multiple processes could access the same file. The client code is responsible for ensuring that no more than one process writes to a file at a given time.

Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.

Properties

lineSeparator : String

Get the current line separator (e.g. '\n' or '\r\n'), if no value is set the system default '\n' will be used.

Constructor Summary

FileWriter(file : File)

Constructs the writer for the specified file.

FileWriter(file : File, append : boolean)

Constructs the writer for the specified file.

FileWriter(file : File, encoding : String)

Constructs the writer for the specified file with the specified encoding.

FileWriter(file : File, encoding : String, append : boolean)

Constructs the writer for the specified file with the specified encoding.

Method Summary

close() : void

Closes the writer.

getLineSeparator() : String

Get the current line separator (e.g.

setLineSeparator(lineSeparator : String) : void

Set the line separator (e.g.

writeLine(str : String) : void

Writes the specified line and appends the line separator.

Methods inherited from class Writer

close, flush, write, write

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constructor Detail

FileWriter

publicFileWriter(file : File)

Constructs the writer for the specified file. Uses "UTF-8" as encoding.

To release system resources, close the writer by calling close().

Parameters:

file - the file object to write to.

FileWriter

publicFileWriter(file : File, append : boolean)

Constructs the writer for the specified file. Optional file append mode is supported. Uses "UTF-8" as encoding.

To release system resources, close the writer by calling close().

Parameters:

file - the file object to write to.

append - flag, whether the file should be written in append mode

FileWriter

publicFileWriter(file : File, encoding : String)

Constructs the writer for the specified file with the specified encoding.

To release system resources, close the writer by calling close().

Parameters:

file - the file object to write to.

encoding - the character encoding to use.

FileWriter

publicFileWriter(file : File, encoding : String, append : boolean)

Constructs the writer for the specified file with the specified encoding. Optional file append mode is supported.

To release system resources, close the writer by calling close().

Parameters:

file - the file object to write to.

encoding - the character encoding to use.

append - flag indicating whether the file should be written in append mode.

Method Detail

close

close() : void

Closes the writer.

getLineSeparator

getLineSeparator() : String

Get the current line separator (e.g. '\n' or '\r\n'), if no value is set the system default '\n' will be used.

setLineSeparator

setLineSeparator(lineSeparator : String) : void

Set the line separator (e.g. '\n' or '\r\n'), if no value is set the system default '\n' will be used.

Parameters:

lineSeparator - that will be written at the end of each line

writeLine

writeLine(str : String) : void

Writes the specified line and appends the line separator.

Parameters:

str - the line to write to the file.