Class PluginProtos.CodeGeneratorResponse.File

public static final class PluginProtos.CodeGeneratorResponse.File extends GeneratedMessageV3 implements PluginProtos.CodeGeneratorResponse.FileOrBuilder


Represents a single generated file.

Protobuf type google.protobuf.compiler.CodeGeneratorResponse.File

Inheritance

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

Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
TypeDescription
int

GENERATED_CODE_INFO_FIELD_NUMBER

public static final int GENERATED_CODE_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

INSERTION_POINT_FIELD_NUMBER

public static final int INSERTION_POINT_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARSER

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

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

getContent()

public String getContent()


The file contents.

optional string content = 15;

Returns
TypeDescription
String

The content.

getContentBytes()

public ByteString getContentBytes()


The file contents.

optional string content = 15;

Returns
TypeDescription
ByteString

The bytes for content.

getDefaultInstance()

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

getDefaultInstanceForType()

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

getDescriptor()

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

getGeneratedCodeInfo()

public DescriptorProtos.GeneratedCodeInfo getGeneratedCodeInfo()


Information describing the file content being inserted. If an insertion
point is used, this information will be appropriately offset and inserted
into the code generation metadata for the generated files.

optional .google.protobuf.GeneratedCodeInfo generated_code_info = 16;

Returns
TypeDescription
DescriptorProtos.GeneratedCodeInfo

The generatedCodeInfo.

getGeneratedCodeInfoOrBuilder()

public DescriptorProtos.GeneratedCodeInfoOrBuilder getGeneratedCodeInfoOrBuilder()


Information describing the file content being inserted. If an insertion
point is used, this information will be appropriately offset and inserted
into the code generation metadata for the generated files.

optional .google.protobuf.GeneratedCodeInfo generated_code_info = 16;

Returns
TypeDescription
DescriptorProtos.GeneratedCodeInfoOrBuilder

getInsertionPoint()

public String getInsertionPoint()


If non-empty, indicates that the named file should already exist, and the
content here is to be inserted into that file at a defined insertion
point. This feature allows a code generator to extend the output
produced by another code generator. The original generator may provide
insertion points by placing special annotations in the file that look
like:
@@protoc_insertion_point(NAME)
The annotation can have arbitrary text before and after it on the line,
which allows it to be placed in a comment. NAME should be replaced with
an identifier naming the point -- this is what other generators will use
as the insertion_point. Code inserted at this point will be placed
immediately above the line containing the insertion point (thus multiple
insertions to the same point will come out in the order they were added).
The double-@ is intended to make it unlikely that the generated code
could contain things that look like insertion points by accident.
For example, the C++ code generator places the following line in the
.pb.h files that it generates:
// @@protoc_insertion_point(namespace_scope)
This line appears within the scope of the file's package namespace, but
outside of any particular class. Another plugin can then specify the
insertion_point "namespace_scope" to generate additional classes or
other declarations that should be placed in this scope.
Note that if the line containing the insertion point begins with
whitespace, the same whitespace will be added to every line of the
inserted text. This is useful for languages like Python, where
indentation matters. In these languages, the insertion point comment
should be indented the same amount as any inserted code will need to be
in order to work correctly in that context.
The code generator that generates the initial file and the one which
inserts into it must both run as part of a single invocation of protoc.
Code generators are executed in the order in which they appear on the
command line.
If |insertion_point| is present, |name| must also be present.

optional string insertion_point = 2;

Returns
TypeDescription
String

The insertionPoint.

getInsertionPointBytes()

public ByteString getInsertionPointBytes()


If non-empty, indicates that the named file should already exist, and the
content here is to be inserted into that file at a defined insertion
point. This feature allows a code generator to extend the output
produced by another code generator. The original generator may provide
insertion points by placing special annotations in the file that look
like:
@@protoc_insertion_point(NAME)
The annotation can have arbitrary text before and after it on the line,
which allows it to be placed in a comment. NAME should be replaced with
an identifier naming the point -- this is what other generators will use
as the insertion_point. Code inserted at this point will be placed
immediately above the line containing the insertion point (thus multiple
insertions to the same point will come out in the order they were added).
The double-@ is intended to make it unlikely that the generated code
could contain things that look like insertion points by accident.
For example, the C++ code generator places the following line in the
.pb.h files that it generates:
// @@protoc_insertion_point(namespace_scope)
This line appears within the scope of the file's package namespace, but
outside of any particular class. Another plugin can then specify the
insertion_point "namespace_scope" to generate additional classes or
other declarations that should be placed in this scope.
Note that if the line containing the insertion point begins with
whitespace, the same whitespace will be added to every line of the
inserted text. This is useful for languages like Python, where
indentation matters. In these languages, the insertion point comment
should be indented the same amount as any inserted code will need to be
in order to work correctly in that context.
The code generator that generates the initial file and the one which
inserts into it must both run as part of a single invocation of protoc.
Code generators are executed in the order in which they appear on the
command line.
If |insertion_point| is present, |name| must also be present.

optional string insertion_point = 2;

Returns
TypeDescription
ByteString

The bytes for insertionPoint.

getName()

public String getName()


The file name, relative to the output directory. The name must not
contain "." or ".." components and must be relative, not be absolute (so,
the file cannot lie outside the output directory). "/" must be used as
the path separator, not "\".
If the name is omitted, the content will be appended to the previous
file. This allows the generator to break large files into small chunks,
and allows the generated text to be streamed back to protoc so that large
files need not reside completely in memory at one time. Note that as of
this writing protoc does not optimize for this -- it will read the entire
CodeGeneratorResponse before writing files to disk.

optional string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()


The file name, relative to the output directory. The name must not
contain "." or ".." components and must be relative, not be absolute (so,
the file cannot lie outside the output directory). "/" must be used as
the path separator, not "\".
If the name is omitted, the content will be appended to the previous
file. This allows the generator to break large files into small chunks,
and allows the generated text to be streamed back to protoc so that large
files need not reside completely in memory at one time. Note that as of
this writing protoc does not optimize for this -- it will read the entire
CodeGeneratorResponse before writing files to disk.

optional string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<PluginProtos.CodeGeneratorResponse.File> getParserForType()
Returns
TypeDescription
Parser<File>
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.

Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Get the UnknownFieldSet for this message.

Returns
TypeDescription
UnknownFieldSet
Overrides

hasContent()

public boolean hasContent()


The file contents.

optional string content = 15;

Returns
TypeDescription
boolean

Whether the content field is set.

hasGeneratedCodeInfo()

public boolean hasGeneratedCodeInfo()


Information describing the file content being inserted. If an insertion
point is used, this information will be appropriately offset and inserted
into the code generation metadata for the generated files.

optional .google.protobuf.GeneratedCodeInfo generated_code_info = 16;

Returns
TypeDescription
boolean

Whether the generatedCodeInfo field is set.

hasInsertionPoint()

public boolean hasInsertionPoint()


If non-empty, indicates that the named file should already exist, and the
content here is to be inserted into that file at a defined insertion
point. This feature allows a code generator to extend the output
produced by another code generator. The original generator may provide
insertion points by placing special annotations in the file that look
like:
@@protoc_insertion_point(NAME)
The annotation can have arbitrary text before and after it on the line,
which allows it to be placed in a comment. NAME should be replaced with
an identifier naming the point -- this is what other generators will use
as the insertion_point. Code inserted at this point will be placed
immediately above the line containing the insertion point (thus multiple
insertions to the same point will come out in the order they were added).
The double-@ is intended to make it unlikely that the generated code
could contain things that look like insertion points by accident.
For example, the C++ code generator places the following line in the
.pb.h files that it generates:
// @@protoc_insertion_point(namespace_scope)
This line appears within the scope of the file's package namespace, but
outside of any particular class. Another plugin can then specify the
insertion_point "namespace_scope" to generate additional classes or
other declarations that should be placed in this scope.
Note that if the line containing the insertion point begins with
whitespace, the same whitespace will be added to every line of the
inserted text. This is useful for languages like Python, where
indentation matters. In these languages, the insertion point comment
should be indented the same amount as any inserted code will need to be
in order to work correctly in that context.
The code generator that generates the initial file and the one which
inserts into it must both run as part of a single invocation of protoc.
Code generators are executed in the order in which they appear on the
command line.
If |insertion_point| is present, |name| must also be present.

optional string insertion_point = 2;

Returns
TypeDescription
boolean

Whether the insertionPoint field is set.

hasName()

public boolean hasName()


The file name, relative to the output directory. The name must not
contain "." or ".." components and must be relative, not be absolute (so,
the file cannot lie outside the output directory). "/" must be used as
the path separator, not "\".
If the name is omitted, the content will be appended to the previous
file. This allows the generator to break large files into small chunks,
and allows the generated text to be streamed back to protoc so that large
files need not reside completely in memory at one time. Note that as of
this writing protoc does not optimize for this -- it will read the entire
CodeGeneratorResponse before writing files to disk.

optional string name = 1;

Returns
TypeDescription
boolean

Whether the name 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

newBuilder()

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

newBuilder(PluginProtos.CodeGeneratorResponse.File prototype)

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

newBuilderForType()

public PluginProtos.CodeGeneratorResponse.File.Builder newBuilderForType()
Returns
TypeDescription
PluginProtos.CodeGeneratorResponse.File.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

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

Parameter
NameDescription
parentGeneratedMessageV3.BuilderParent
Returns
TypeDescription
PluginProtos.CodeGeneratorResponse.File.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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

toBuilder()

public PluginProtos.CodeGeneratorResponse.File.Builder toBuilder()
Returns
TypeDescription
PluginProtos.CodeGeneratorResponse.File.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