Package protopoet

Class OptionSpec

java.lang.Object

protopoet.OptionSpec

All Implemented Interfaces:

Buildable<OptionSpec>

public final class OptionSpec
extends java.lang.Object
implements Buildable<OptionSpec>

Models an Option in the Protocol Buffers language. Learn more: https://developers.google.com/protocol-buffers/docs/proto#options

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OptionSpec.Builder	Builder for producing new instances of OptionSpec.

Method Summary

Modifier and Type	Method	Description
OptionSpec	build()	Returns a built instance of the declared type.
void	emit(protopoet.ProtoWriter writer)
static OptionSpec.Builder	enumOption(java.lang.String optionName)	Creates a builder for a Enum OptionSpec.
static OptionSpec.Builder	enumValueOption(java.lang.String optionName)	Creates a builder for a Enum Value OptionSpec.
static OptionSpec.Builder	fieldOption(java.lang.String optionName)	Creates a builder for a Field OptionSpec.
static OptionSpec.Builder	fileOption(java.lang.String optionName)	Creates a builder for a File OptionSpec.
static OptionSpec.Builder	messageOption(java.lang.String optionName)	Creates a builder for a Message OptionSpec.
static OptionSpec.Builder	methodOption(java.lang.String optionName)	Creates a builder for a Method OptionSpec.
static OptionSpec.Builder	oneofOption(java.lang.String optionName)	Creates a builder for a Oneof OptionSpec.
static OptionSpec.Builder	serviceOption(java.lang.String optionName)	Creates a builder for a Service OptionSpec.

Methods inherited from class java.lang.Object

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

Method Detail

fileOption

public static OptionSpec.Builder fileOption(java.lang.String optionName)

Creates a builder for a File OptionSpec.

messageOption

public static OptionSpec.Builder messageOption(java.lang.String optionName)

Creates a builder for a Message OptionSpec.

fieldOption

public static OptionSpec.Builder fieldOption(java.lang.String optionName)

Creates a builder for a Field OptionSpec.

enumOption

public static OptionSpec.Builder enumOption(java.lang.String optionName)

Creates a builder for a Enum OptionSpec.

enumValueOption

public static OptionSpec.Builder enumValueOption(java.lang.String optionName)

Creates a builder for a Enum Value OptionSpec.

serviceOption

public static OptionSpec.Builder serviceOption(java.lang.String optionName)

Creates a builder for a Service OptionSpec.

oneofOption

public static OptionSpec.Builder oneofOption(java.lang.String optionName)

Creates a builder for a Oneof OptionSpec.

methodOption

public static OptionSpec.Builder methodOption(java.lang.String optionName)

Creates a builder for a Method OptionSpec.

emit

public void emit(protopoet.ProtoWriter writer)
          throws java.io.IOException

Throws:

java.io.IOException

build

public OptionSpec build()

Description copied from interface: Buildable

Returns a built instance of the declared type.

Specified by:

build in interface Buildable<OptionSpec>