io.spine.js.generate

Class GenerationTask

java.lang.Object

io.spine.js.generate.GenerationTask

Direct Known Subclasses:

AppendTypeUrlGetter, GenerateIndexFile, GenerateKnownTypeParsers, ResolveImports

public abstract class GenerationTask
extends java.lang.Object

A code generation task for Protobuf declarations.

The class operates on the provided set of Protobuf files and enhances their JavaScript counterparts by generating additional code.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenerationTask(io.spine.code.fs.js.Directory generatedRoot)

Method Summary

Modifier and Type	Method and Description
protected io.spine.code.proto.FileSet	filter(io.spine.code.proto.FileSet fileSet) Filters out files that should not processed by the task.
protected io.spine.code.fs.js.Directory	generatedRoot() Obtains the root of the generated Protobuf sources.
protected abstract void	generateFor(io.spine.code.proto.FileSet fileSet) Generates code for the Protobuf files.
void	performFor(io.spine.code.proto.FileSet fileSet) Generates code for the specified file set.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerationTask

protected GenerationTask(io.spine.code.fs.js.Directory generatedRoot)

Method Detail

performFor

public final void performFor(io.spine.code.proto.FileSet fileSet)

Generates code for the specified file set.

Parameters:

fileSet - the Protobuf files to generate code for

filter

protected io.spine.code.proto.FileSet filter(io.spine.code.proto.FileSet fileSet)

Filters out files that should not processed by the task.

The method filters out files that don't belong to the module. A file is considered belonging to the module if it was compiled to JavaScript. A .js file is checked instead of an original .proto file since a module can expose Protobufs defined by other modules and these files still should be handled.

Parameters:

fileSet - the files to filter

Returns:

the files to perform the taks for

generateFor

protected abstract void generateFor(io.spine.code.proto.FileSet fileSet)

Generates code for the Protobuf files.

generatedRoot

protected io.spine.code.fs.js.Directory generatedRoot()

Obtains the root of the generated Protobuf sources.