Class PluginProtos.CodeGeneratorRequest

Stay organized with collections Save and categorize content based on your preferences.
public static final class PluginProtos.CodeGeneratorRequest extends GeneratedMessageV3 implements PluginProtos.CodeGeneratorRequestOrBuilder

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

Protobuf type google.protobuf.compiler.CodeGeneratorRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PluginProtos.CodeGeneratorRequest

Static Fields

COMPILER_VERSION_FIELD_NUMBER

public static final int COMPILER_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

FILE_TO_GENERATE_FIELD_NUMBER

public static final int FILE_TO_GENERATE_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETER_FIELD_NUMBER

public static final int PARAMETER_FIELD_NUMBER
Field Value
TypeDescription
int

PARSER

public static final Parser<PluginProtos.CodeGeneratorRequest> PARSER
Field Value
TypeDescription
Parser<CodeGeneratorRequest>

PROTO_FILE_FIELD_NUMBER

public static final int PROTO_FILE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PluginProtos.CodeGeneratorRequest getDefaultInstance()
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptors.Descriptor

newBuilder()

public static PluginProtos.CodeGeneratorRequest.Builder newBuilder()
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest.Builder

newBuilder(PluginProtos.CodeGeneratorRequest prototype)

public static PluginProtos.CodeGeneratorRequest.Builder newBuilder(PluginProtos.CodeGeneratorRequest prototype)
Parameter
NameDescription
prototypePluginProtos.CodeGeneratorRequest
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest.Builder

parseDelimitedFrom(InputStream input)

public static PluginProtos.CodeGeneratorRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PluginProtos.CodeGeneratorRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PluginProtos.CodeGeneratorRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PluginProtos.CodeGeneratorRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PluginProtos.CodeGeneratorRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PluginProtos.CodeGeneratorRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PluginProtos.CodeGeneratorRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PluginProtos.CodeGeneratorRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PluginProtos.CodeGeneratorRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PluginProtos.CodeGeneratorRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PluginProtos.CodeGeneratorRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PluginProtos.CodeGeneratorRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PluginProtos.CodeGeneratorRequest> parser()
Returns
TypeDescription
Parser<CodeGeneratorRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

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.

Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCompilerVersion()

public PluginProtos.Version getCompilerVersion()

The version number of protocol compiler.

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

Returns
TypeDescription
PluginProtos.Version

The compilerVersion.

getCompilerVersionOrBuilder()

public PluginProtos.VersionOrBuilder getCompilerVersionOrBuilder()

The version number of protocol compiler.

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

Returns
TypeDescription
PluginProtos.VersionOrBuilder

getDefaultInstanceForType()

public PluginProtos.CodeGeneratorRequest getDefaultInstanceForType()

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.

Returns
TypeDescription
PluginProtos.CodeGeneratorRequest

getFileToGenerate(int index)

public 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;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The fileToGenerate at the given index.

getFileToGenerateBytes(int index)

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;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the fileToGenerate at the given index.

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;

Returns
TypeDescription
int

The count of fileToGenerate.

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;

Returns
TypeDescription
ProtocolStringList

A list containing the fileToGenerate.

getParameter()

public String getParameter()

The generator parameter passed on the command-line.

optional string parameter = 2;

Returns
TypeDescription
String

The parameter.

getParameterBytes()

public ByteString getParameterBytes()

The generator parameter passed on the command-line.

optional string parameter = 2;

Returns
TypeDescription
ByteString

The bytes for parameter.

getParserForType()

public Parser<PluginProtos.CodeGeneratorRequest> getParserForType()
Returns
TypeDescription
Parser<CodeGeneratorRequest>
Overrides

getProtoFile(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.FileDescriptorProto

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;

Returns
TypeDescription
int

getProtoFileList()

public 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;

Returns
TypeDescription
List<FileDescriptorProto>

getProtoFileOrBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.FileDescriptorProtoOrBuilder

getProtoFileOrBuilderList()

public 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;

Returns
TypeDescription
List<? extends com.google.protobuf.DescriptorProtos.FileDescriptorProtoOrBuilder>

getSerializedSize()

public int getSerializedSize()

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

If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.

Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Get the UnknownFieldSet for this message.

Returns
TypeDescription
UnknownFieldSet
Overrides

hasCompilerVersion()

public boolean hasCompilerVersion()

The version number of protocol compiler.

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

Returns
TypeDescription
boolean

Whether the compilerVersion field is set.

hasParameter()

public boolean hasParameter()

The generator parameter passed on the command-line.

optional string parameter = 2;

Returns
TypeDescription
boolean

Whether the parameter field is set.

hashCode()

public int hashCode()

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.

Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.

Returns
TypeDescription
GeneratedMessageV3.FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()

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

See also: MessageOrBuilder#getInitializationErrorString()

Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PluginProtos.CodeGeneratorRequest.Builder newBuilderForType()
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PluginProtos.CodeGeneratorRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.

Parameter
NameDescription
parentGeneratedMessageV3.BuilderParent
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Creates a new instance of this message type. Overridden in the generated code.

Parameter
NameDescription
unusedGeneratedMessageV3.UnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PluginProtos.CodeGeneratorRequest.Builder toBuilder()
Returns
TypeDescription
PluginProtos.CodeGeneratorRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

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

Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException