io.spine.tools.compiler.annotation

Class ModuleAnnotator.Builder

java.lang.Object

io.spine.tools.compiler.annotation.ModuleAnnotator.Builder

Enclosing class:

ModuleAnnotator

public static final class ModuleAnnotator.Builder
extends java.lang.Object

A builder for the ModuleAnnotator instances.

Method Summary

Modifier and Type	Method and Description
ModuleAnnotator.Builder	add(ModuleAnnotator.Job job) Adds a ModuleAnnotator.Job to execute.
ModuleAnnotator	build() Creates a new instance of ModuleAnnotator.
ModuleAnnotator.Builder	setAnnotatorFactory(AnnotatorFactory annotatorFactory)
ModuleAnnotator.Builder	setInternalAnnotation(io.spine.code.java.ClassName internalAnnotation) Specifies the internal annotation class name.
ModuleAnnotator.Builder	setInternalMethodNames(com.google.common.collect.ImmutableSet<java.lang.String> methodNames) Sets names of methods to be annotated as internal.
ModuleAnnotator.Builder	setInternalPatterns(com.google.common.collect.ImmutableSet<java.lang.String> patterns) Sets patters for Java classes to be annotated as internal.

Methods inherited from class java.lang.Object

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

Method Detail

setAnnotatorFactory

public ModuleAnnotator.Builder setAnnotatorFactory(AnnotatorFactory annotatorFactory)

add

@CanIgnoreReturnValue
public ModuleAnnotator.Builder add(ModuleAnnotator.Job job)

Adds a ModuleAnnotator.Job to execute.

See Also:

the {@code Job} construction DSL

setInternalPatterns

public ModuleAnnotator.Builder setInternalPatterns(com.google.common.collect.ImmutableSet<java.lang.String> patterns)

Sets patters for Java classes to be annotated as internal.

The patterns are compiled with no additional flags.

All the classes, fully qualified canonical names of which match at least one of the given patterns, should be marked as internal by the resulting annotator.

Parameters:

patterns - class name patterns

See Also:

setInternalAnnotation(io.spine.code.java.ClassName)

setInternalMethodNames

public ModuleAnnotator.Builder setInternalMethodNames(com.google.common.collect.ImmutableSet<java.lang.String> methodNames)

Sets names of methods to be annotated as internal.

Parameters:

methodNames - the method names

See Also:

setInternalAnnotation(io.spine.code.java.ClassName)

setInternalAnnotation

public ModuleAnnotator.Builder setInternalAnnotation(io.spine.code.java.ClassName internalAnnotation)

Specifies the internal annotation class name.

This annotation will be used to mark internal classes and methods.

Parameters:

internalAnnotation - annotation class name

build

public ModuleAnnotator build()

Creates a new instance of ModuleAnnotator.

Returns:

new instance of ModuleAnnotator