com.google.protobuf.compiler

Class PluginProtos.CodeGeneratorRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.protobuf.compiler.PluginProtos.CodeGeneratorRequest

All Implemented Interfaces:

PluginProtos.CodeGeneratorRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

Enclosing class:

PluginProtos

public static final class PluginProtos.CodeGeneratorRequest
extends com.google.protobuf.GeneratedMessageV3
implements PluginProtos.CodeGeneratorRequestOrBuilder

 An encoded CodeGeneratorRequest is written to the plugin's stdin.
 

Protobuf type google.protobuf.compiler.CodeGeneratorRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginProtos.CodeGeneratorRequest.Builder An encoded CodeGeneratorRequest is written to the plugin's stdin.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPILER_VERSION_FIELD_NUMBER
static int	FILE_TO_GENERATE_FIELD_NUMBER
static int	PARAMETER_FIELD_NUMBER
static Parser<PluginProtos.CodeGeneratorRequest>	PARSER Deprecated.
static int	PROTO_FILE_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares the specified object with this message for equality.
PluginProtos.Version	getCompilerVersion() The version number of protocol compiler.
PluginProtos.VersionOrBuilder	getCompilerVersionOrBuilder() The version number of protocol compiler.
static PluginProtos.CodeGeneratorRequest	getDefaultInstance()
PluginProtos.CodeGeneratorRequest	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
java.lang.String	getFileToGenerate(int index) The .proto files that were explicitly listed on the command-line.
ByteString	getFileToGenerateBytes(int index) The .proto files that were explicitly listed on the command-line.
int	getFileToGenerateCount() The .proto files that were explicitly listed on the command-line.
ProtocolStringList	getFileToGenerateList() The .proto files that were explicitly listed on the command-line.
java.lang.String	getParameter() The generator parameter passed on the command-line.
ByteString	getParameterBytes() The generator parameter passed on the command-line.
Parser<PluginProtos.CodeGeneratorRequest>	getParserForType() Gets the parser for a message of the same type as this message.
DescriptorProtos.FileDescriptorProto	getProtoFile(int index) FileDescriptorProtos for all files in files_to_generate and everything they import.
int	getProtoFileCount() FileDescriptorProtos for all files in files_to_generate and everything they import.
java.util.List<DescriptorProtos.FileDescriptorProto>	getProtoFileList() FileDescriptorProtos for all files in files_to_generate and everything they import.
DescriptorProtos.FileDescriptorProtoOrBuilder	getProtoFileOrBuilder(int index) FileDescriptorProtos for all files in files_to_generate and everything they import.
java.util.List<? extends DescriptorProtos.FileDescriptorProtoOrBuilder>	getProtoFileOrBuilderList() FileDescriptorProtos for all files in files_to_generate and everything they import.
int	getSerializedSize() Get the number of bytes required to encode this message.
com.google.protobuf.UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
boolean	hasCompilerVersion() The version number of protocol compiler.
int	hashCode() Returns the hash code value for this message.
boolean	hasParameter() The generator parameter passed on the command-line.
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
static PluginProtos.CodeGeneratorRequest.Builder	newBuilder()
static PluginProtos.CodeGeneratorRequest.Builder	newBuilder(PluginProtos.CodeGeneratorRequest prototype)
PluginProtos.CodeGeneratorRequest.Builder	newBuilderForType() Constructs a new builder for a message of the same type as this message.
static PluginProtos.CodeGeneratorRequest	parseDelimitedFrom(java.io.InputStream input)
static PluginProtos.CodeGeneratorRequest	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static PluginProtos.CodeGeneratorRequest	parseFrom(byte[] data)
static PluginProtos.CodeGeneratorRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static PluginProtos.CodeGeneratorRequest	parseFrom(java.nio.ByteBuffer data)
static PluginProtos.CodeGeneratorRequest	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static PluginProtos.CodeGeneratorRequest	parseFrom(ByteString data)
static PluginProtos.CodeGeneratorRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static PluginProtos.CodeGeneratorRequest	parseFrom(CodedInputStream input)
static PluginProtos.CodeGeneratorRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static PluginProtos.CodeGeneratorRequest	parseFrom(java.io.InputStream input)
static PluginProtos.CodeGeneratorRequest	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<PluginProtos.CodeGeneratorRequest>	parser()
PluginProtos.CodeGeneratorRequest.Builder	toBuilder() Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output) Serializes the message and writes it to output.

Methods inherited from class com.google.protobuf.GeneratedMessageV3

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FILE_TO_GENERATE_FIELD_NUMBER

public static final int FILE_TO_GENERATE_FIELD_NUMBER

See Also:

Constant Field Values

PARAMETER_FIELD_NUMBER

public static final int PARAMETER_FIELD_NUMBER

See Also:

Constant Field Values

PROTO_FILE_FIELD_NUMBER

public static final int PROTO_FILE_FIELD_NUMBER

See Also:

Constant Field Values

COMPILER_VERSION_FIELD_NUMBER

public static final int COMPILER_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final Parser<PluginProtos.CodeGeneratorRequest> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

getFileToGenerateList

public ProtocolStringList getFileToGenerateList()

 The .proto files that were explicitly listed on the command-line.  The
 code generator should generate code only for these files.  Each file's
 descriptor will be included in proto_file, below.
 

repeated string file_to_generate = 1;

Specified by:

getFileToGenerateList in interface PluginProtos.CodeGeneratorRequestOrBuilder

Returns:

A list containing the fileToGenerate.

getFileToGenerateCount

public int getFileToGenerateCount()

 The .proto files that were explicitly listed on the command-line.  The
 code generator should generate code only for these files.  Each file's
 descriptor will be included in proto_file, below.
 

repeated string file_to_generate = 1;

Specified by:

getFileToGenerateCount in interface PluginProtos.CodeGeneratorRequestOrBuilder

Returns:

The count of fileToGenerate.

getFileToGenerate

public java.lang.String getFileToGenerate(int index)

 The .proto files that were explicitly listed on the command-line.  The
 code generator should generate code only for these files.  Each file's
 descriptor will be included in proto_file, below.
 

repeated string file_to_generate = 1;

Specified by:

getFileToGenerate in interface PluginProtos.CodeGeneratorRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The fileToGenerate at the given index.

getFileToGenerateBytes

public ByteString getFileToGenerateBytes(int index)

 The .proto files that were explicitly listed on the command-line.  The
 code generator should generate code only for these files.  Each file's
 descriptor will be included in proto_file, below.
 

repeated string file_to_generate = 1;

Specified by:

getFileToGenerateBytes in interface PluginProtos.CodeGeneratorRequestOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the fileToGenerate at the given index.

hasParameter

public boolean hasParameter()

 The generator parameter passed on the command-line.
 

optional string parameter = 2;

Specified by:

hasParameter in interface PluginProtos.CodeGeneratorRequestOrBuilder

Returns:

Whether the parameter field is set.

getParameter

public java.lang.String getParameter()

 The generator parameter passed on the command-line.
 

optional string parameter = 2;

Specified by:

getParameter in interface PluginProtos.CodeGeneratorRequestOrBuilder

Returns:

The parameter.

getParameterBytes

public ByteString getParameterBytes()

 The generator parameter passed on the command-line.
 

optional string parameter = 2;

Specified by:

getParameterBytes in interface PluginProtos.CodeGeneratorRequestOrBuilder

Returns:

The bytes for parameter.

getProtoFileList

public java.util.List<DescriptorProtos.FileDescriptorProto> getProtoFileList()

 FileDescriptorProtos for all files in files_to_generate and everything
 they import.  The files will appear in topological order, so each file
 appears before any file that imports it.
 protoc guarantees that all proto_files will be written after
 the fields above, even though this is not technically guaranteed by the
 protobuf wire format.  This theoretically could allow a plugin to stream
 in the FileDescriptorProtos and handle them one by one rather than read
 the entire set into memory at once.  However, as of this writing, this
 is not similarly optimized on protoc's end -- it will store all fields in
 memory at once before sending them to the plugin.
 Type names of fields and extensions in the FileDescriptorProto are always
 fully qualified.
 

repeated .google.protobuf.FileDescriptorProto proto_file = 15;

Specified by:

getProtoFileList in interface PluginProtos.CodeGeneratorRequestOrBuilder

getProtoFileOrBuilderList

public java.util.List<? extends DescriptorProtos.FileDescriptorProtoOrBuilder> getProtoFileOrBuilderList()

 FileDescriptorProtos for all files in files_to_generate and everything
 they import.  The files will appear in topological order, so each file
 appears before any file that imports it.
 protoc guarantees that all proto_files will be written after
 the fields above, even though this is not technically guaranteed by the
 protobuf wire format.  This theoretically could allow a plugin to stream
 in the FileDescriptorProtos and handle them one by one rather than read
 the entire set into memory at once.  However, as of this writing, this
 is not similarly optimized on protoc's end -- it will store all fields in
 memory at once before sending them to the plugin.
 Type names of fields and extensions in the FileDescriptorProto are always
 fully qualified.
 

repeated .google.protobuf.FileDescriptorProto proto_file = 15;

Specified by:

getProtoFileOrBuilderList in interface PluginProtos.CodeGeneratorRequestOrBuilder

getProtoFileCount

public int getProtoFileCount()

 FileDescriptorProtos for all files in files_to_generate and everything
 they import.  The files will appear in topological order, so each file
 appears before any file that imports it.
 protoc guarantees that all proto_files will be written after
 the fields above, even though this is not technically guaranteed by the
 protobuf wire format.  This theoretically could allow a plugin to stream
 in the FileDescriptorProtos and handle them one by one rather than read
 the entire set into memory at once.  However, as of this writing, this
 is not similarly optimized on protoc's end -- it will store all fields in
 memory at once before sending them to the plugin.
 Type names of fields and extensions in the FileDescriptorProto are always
 fully qualified.
 

repeated .google.protobuf.FileDescriptorProto proto_file = 15;

Specified by:

getProtoFileCount in interface PluginProtos.CodeGeneratorRequestOrBuilder

getProtoFile

public DescriptorProtos.FileDescriptorProto getProtoFile(int index)

 FileDescriptorProtos for all files in files_to_generate and everything
 they import.  The files will appear in topological order, so each file
 appears before any file that imports it.
 protoc guarantees that all proto_files will be written after
 the fields above, even though this is not technically guaranteed by the
 protobuf wire format.  This theoretically could allow a plugin to stream
 in the FileDescriptorProtos and handle them one by one rather than read
 the entire set into memory at once.  However, as of this writing, this
 is not similarly optimized on protoc's end -- it will store all fields in
 memory at once before sending them to the plugin.
 Type names of fields and extensions in the FileDescriptorProto are always
 fully qualified.
 

repeated .google.protobuf.FileDescriptorProto proto_file = 15;

Specified by:

getProtoFile in interface PluginProtos.CodeGeneratorRequestOrBuilder

getProtoFileOrBuilder

public DescriptorProtos.FileDescriptorProtoOrBuilder getProtoFileOrBuilder(int index)

 FileDescriptorProtos for all files in files_to_generate and everything
 they import.  The files will appear in topological order, so each file
 appears before any file that imports it.
 protoc guarantees that all proto_files will be written after
 the fields above, even though this is not technically guaranteed by the
 protobuf wire format.  This theoretically could allow a plugin to stream
 in the FileDescriptorProtos and handle them one by one rather than read
 the entire set into memory at once.  However, as of this writing, this
 is not similarly optimized on protoc's end -- it will store all fields in
 memory at once before sending them to the plugin.
 Type names of fields and extensions in the FileDescriptorProto are always
 fully qualified.
 

repeated .google.protobuf.FileDescriptorProto proto_file = 15;

Specified by:

getProtoFileOrBuilder in interface PluginProtos.CodeGeneratorRequestOrBuilder

hasCompilerVersion

public boolean hasCompilerVersion()

 The version number of protocol compiler.
 

optional .google.protobuf.compiler.Version compiler_version = 3;

Specified by:

hasCompilerVersion in interface PluginProtos.CodeGeneratorRequestOrBuilder

Returns:

Whether the compilerVersion field is set.

getCompilerVersion

public PluginProtos.Version getCompilerVersion()

 The version number of protocol compiler.
 

optional .google.protobuf.compiler.Version compiler_version = 3;

Specified by:

getCompilerVersion in interface PluginProtos.CodeGeneratorRequestOrBuilder

Returns:

The compilerVersion.

getCompilerVersionOrBuilder

public PluginProtos.VersionOrBuilder getCompilerVersionOrBuilder()

 The version number of protocol compiler.
 

optional .google.protobuf.compiler.Version compiler_version = 3;

Specified by:

getCompilerVersionOrBuilder in interface PluginProtos.CodeGeneratorRequestOrBuilder

isInitialized

public final boolean isInitialized()

Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Description copied from interface: MessageLite

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: Message

Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

Parameters:

obj - object to be compared for equality with this message

Returns:

true if the specified object is equal to this message

hashCode

public int hashCode()

Description copied from interface: Message

Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

Returns:

the hash code value for this message

See Also:

Map.hashCode()

parseFrom

public static PluginProtos.CodeGeneratorRequest parseFrom(java.nio.ByteBuffer data)
                                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PluginProtos.CodeGeneratorRequest parseFrom(java.nio.ByteBuffer data,
                                                          ExtensionRegistryLite extensionRegistry)
                                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PluginProtos.CodeGeneratorRequest parseFrom(ByteString data)
                                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PluginProtos.CodeGeneratorRequest parseFrom(ByteString data,
                                                          ExtensionRegistryLite extensionRegistry)
                                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PluginProtos.CodeGeneratorRequest parseFrom(byte[] data)
                                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PluginProtos.CodeGeneratorRequest parseFrom(byte[] data,
                                                          ExtensionRegistryLite extensionRegistry)
                                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PluginProtos.CodeGeneratorRequest parseFrom(java.io.InputStream input)
                                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PluginProtos.CodeGeneratorRequest parseFrom(java.io.InputStream input,
                                                          ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static PluginProtos.CodeGeneratorRequest parseDelimitedFrom(java.io.InputStream input)
                                                            throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static PluginProtos.CodeGeneratorRequest parseDelimitedFrom(java.io.InputStream input,
                                                                   ExtensionRegistryLite extensionRegistry)
                                                            throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PluginProtos.CodeGeneratorRequest parseFrom(CodedInputStream input)
                                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PluginProtos.CodeGeneratorRequest parseFrom(CodedInputStream input,
                                                          ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public PluginProtos.CodeGeneratorRequest.Builder newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static PluginProtos.CodeGeneratorRequest.Builder newBuilder()

newBuilder

public static PluginProtos.CodeGeneratorRequest.Builder newBuilder(PluginProtos.CodeGeneratorRequest prototype)

toBuilder

public PluginProtos.CodeGeneratorRequest.Builder toBuilder()

Description copied from interface: MessageLite

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

getDefaultInstance

public static PluginProtos.CodeGeneratorRequest getDefaultInstance()

parser

public static Parser<PluginProtos.CodeGeneratorRequest> parser()

getParserForType

public Parser<PluginProtos.CodeGeneratorRequest> getParserForType()

Description copied from interface: MessageLite

Gets the parser for a message of the same type as this message.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public PluginProtos.CodeGeneratorRequest getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder