io.spine.tools.compiler.annotation

Class ModuleAnnotator

java.lang.Object

io.spine.tools.compiler.annotation.ModuleAnnotator

public final class ModuleAnnotator
extends java.lang.Object

A source code annotation facade.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleAnnotator.Builder A builder for the ModuleAnnotator instances.
static interface	ModuleAnnotator.Job A job of the annotator.
static class	ModuleAnnotator.JobBuilder A builder of ModuleAnnotator.Job instances.

Method Summary

Modifier and Type	Method and Description
void	annotate() Executes the annotation jobs.
static ModuleAnnotator.Builder	newBuilder() Creates a new instance of Builder for ModuleAnnotator instances.
static ModuleAnnotator.JobBuilder	translate(ApiOption option) Creates a new ModuleAnnotator.JobBuilder.

Methods inherited from class java.lang.Object

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

Method Detail

annotate

public void annotate()

Executes the annotation jobs.

translate

public static ModuleAnnotator.JobBuilder translate(ApiOption option)

Creates a new ModuleAnnotator.JobBuilder.

Start constructing a ModuleAnnotator.Job from this method.

newBuilder

public static ModuleAnnotator.Builder newBuilder()

Creates a new instance of Builder for ModuleAnnotator instances.

Returns:

new instance of Builder