io.spine.js.generate.output

Class FileWriter

java.lang.Object

io.spine.js.generate.output.FileWriter

public final class FileWriter
extends java.lang.Object

A writer of JavaScript code into a file.

The class wraps all IOExceptions which occur during its operations in the IllegalStateException.

Method Summary

Modifier and Type	Method and Description
void	append(CodeLines jsOutput) Appends the given output to the end of the file.
static FileWriter	createFor(io.spine.code.fs.js.Directory directory, com.google.protobuf.Descriptors.FileDescriptor file) Creates a new instance which will operate on the file pointed by the file descriptor and located in the specified directory.
static FileWriter	createFor(io.spine.code.fs.js.Directory directory, io.spine.code.fs.js.LibraryFile libraryFile) Creates a new instance which will operate on the specified library file located in the specified directory.
void	write(CodeLines jsOutput) Writes the given output to the file.

Methods inherited from class java.lang.Object

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

Method Detail

createFor

public static FileWriter createFor(io.spine.code.fs.js.Directory directory,
                                   io.spine.code.fs.js.LibraryFile libraryFile)

Creates a new instance which will operate on the specified library file located in the specified directory.

createFor

public static FileWriter createFor(io.spine.code.fs.js.Directory directory,
                                   com.google.protobuf.Descriptors.FileDescriptor file)

Creates a new instance which will operate on the file pointed by the file descriptor and located in the specified directory.

write

public void write(CodeLines jsOutput)

Writes the given output to the file.

Overwrites the previous file content.

Parameters:

jsOutput - the JsOutput to write

Throws:

java.lang.IllegalStateException - if something went wrong when writing to file

append

public void append(CodeLines jsOutput)

Appends the given output to the end of the file.

Parameters:

jsOutput - the JsOutput to append

Throws:

java.lang.IllegalStateException - if something went wrong when writing to file