dw.io
Class 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.
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
public FileWriter(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
public FileWriter(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
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
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
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.
© Copyright 2000-2023, salesforce.com inc. All rights reserved. Various trademarks held by their respective owners.