io.spine.tools.compiler.annotation

Class ApiOption

java.lang.Object

io.spine.tools.compiler.annotation.ApiOption

@Immutable
public final class ApiOption
extends java.lang.Object

A set of Protobuf options marking an API element.

The options in a single set have different targets (such as files, message types, fields, etc.), but always represent a singe concept in terms of API visibility, status, etc.

For example, options (beta), (beta_type), and (beta_all) target, respectively, fields, messages, and files, but all represent a single concept - a beta API element.

Method Summary

Modifier and Type	Method and Description
static ApiOption	beta() Obtains an option which marks beta API.
static ApiOption	experimental() Obtains an option which marks experimental API.
static ApiOption	internal() Obtains an option which marks internal API.
static ApiOption	spi() Obtains an option which marks beta service provider interface elements.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

beta

public static ApiOption beta()

Obtains an option which marks beta API.

spi

public static ApiOption spi()

Obtains an option which marks beta service provider interface elements.

experimental

public static ApiOption experimental()

Obtains an option which marks experimental API.

internal

public static ApiOption internal()

Obtains an option which marks internal API.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object