Class PluginProtos.CodeGeneratorResponse

public static final class PluginProtos.CodeGeneratorResponse extends GeneratedMessageV3 implements PluginProtos.CodeGeneratorResponseOrBuilder

The plugin writes an encoded CodeGeneratorResponse to stdout.

Protobuf type google.protobuf.compiler.CodeGeneratorResponse

Inheritance

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

Static Fields

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

FILE_FIELD_NUMBER

public static final int FILE_FIELD_NUMBER
Field Value
TypeDescription
int

PARSER

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

SUPPORTED_FEATURES_FIELD_NUMBER

public static final int SUPPORTED_FEATURES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(PluginProtos.CodeGeneratorResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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

getDefaultInstanceForType()

public PluginProtos.CodeGeneratorResponse 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.CodeGeneratorResponse

getError()

public String getError()

Error message. If non-empty, code generation failed. The plugin process should exit with status code zero even if it reports an error in this way. This should be used to indicate errors in .proto files which prevent the code generator from generating correct code. Errors which indicate a problem in protoc itself -- such as the input CodeGeneratorRequest being unparseable -- should be reported by writing a message to stderr and exiting with a non-zero status code.

optional string error = 1;

Returns
TypeDescription
String

The error.

getErrorBytes()

public ByteString getErrorBytes()

Error message. If non-empty, code generation failed. The plugin process should exit with status code zero even if it reports an error in this way. This should be used to indicate errors in .proto files which prevent the code generator from generating correct code. Errors which indicate a problem in protoc itself -- such as the input CodeGeneratorRequest being unparseable -- should be reported by writing a message to stderr and exiting with a non-zero status code.

optional string error = 1;

Returns
TypeDescription
ByteString

The bytes for error.

getFile(int index)

public PluginProtos.CodeGeneratorResponse.File getFile(int index)

repeated .google.protobuf.compiler.CodeGeneratorResponse.File file = 15;

Parameter
NameDescription
indexint
Returns
TypeDescription
PluginProtos.CodeGeneratorResponse.File

getFileCount()

public int getFileCount()

repeated .google.protobuf.compiler.CodeGeneratorResponse.File file = 15;

Returns
TypeDescription
int

getFileList()

public List<PluginProtos.CodeGeneratorResponse.File> getFileList()

repeated .google.protobuf.compiler.CodeGeneratorResponse.File file = 15;

Returns
TypeDescription
List<File>

getFileOrBuilder(int index)

public PluginProtos.CodeGeneratorResponse.FileOrBuilder getFileOrBuilder(int index)

repeated .google.protobuf.compiler.CodeGeneratorResponse.File file = 15;

Parameter
NameDescription
indexint
Returns
TypeDescription
PluginProtos.CodeGeneratorResponse.FileOrBuilder

getFileOrBuilderList()

public List<? extends PluginProtos.CodeGeneratorResponse.FileOrBuilder> getFileOrBuilderList()

repeated .google.protobuf.compiler.CodeGeneratorResponse.File file = 15;

Returns
TypeDescription
List<? extends com.google.protobuf.compiler.PluginProtos.CodeGeneratorResponse.FileOrBuilder>

getParserForType()

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

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

getSupportedFeatures()

public long getSupportedFeatures()

A bitmask of supported features that the code generator supports. This is a bitwise "or" of values from the Feature enum.

optional uint64 supported_features = 2;

Returns
TypeDescription
long

The supportedFeatures.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Get the UnknownFieldSet for this message.

Returns
TypeDescription
UnknownFieldSet
Overrides

hasError()

public boolean hasError()

Error message. If non-empty, code generation failed. The plugin process should exit with status code zero even if it reports an error in this way. This should be used to indicate errors in .proto files which prevent the code generator from generating correct code. Errors which indicate a problem in protoc itself -- such as the input CodeGeneratorRequest being unparseable -- should be reported by writing a message to stderr and exiting with a non-zero status code.

optional string error = 1;

Returns
TypeDescription
boolean

Whether the error field is set.

hasSupportedFeatures()

public boolean hasSupportedFeatures()

A bitmask of supported features that the code generator supports. This is a bitwise "or" of values from the Feature enum.

optional uint64 supported_features = 2;

Returns
TypeDescription
boolean

Whether the supportedFeatures 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.CodeGeneratorResponse.Builder newBuilderForType()
Returns
TypeDescription
PluginProtos.CodeGeneratorResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

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

Parameter
NameDescription
parentGeneratedMessageV3.BuilderParent
Returns
TypeDescription
PluginProtos.CodeGeneratorResponse.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.CodeGeneratorResponse.Builder toBuilder()
Returns
TypeDescription
PluginProtos.CodeGeneratorResponse.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