Class DescriptorProtos.SourceCodeInfo.Location

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.generated.DescriptorProtos.SourceCodeInfo.Location
All Implemented Interfaces:
DescriptorProtos.SourceCodeInfo.LocationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
DescriptorProtos.SourceCodeInfo
public static final class DescriptorProtos.SourceCodeInfo.Location extends com.google.protobuf.GeneratedMessage implements DescriptorProtos.SourceCodeInfo.LocationOrBuilder
Protobuf type google.protobuf.SourceCodeInfo.Location
See Also:

  • Field Details

    • PATH_FIELD_NUMBER

      public static final int PATH_FIELD_NUMBER
      See Also:

    • SPAN_FIELD_NUMBER

      public static final int SPAN_FIELD_NUMBER
      See Also:

    • LEADING_COMMENTS_FIELD_NUMBER

      public static final int LEADING_COMMENTS_FIELD_NUMBER
      See Also:

    • TRAILING_COMMENTS_FIELD_NUMBER

      public static final int TRAILING_COMMENTS_FIELD_NUMBER
      See Also:

    • LEADING_DETACHED_COMMENTS_FIELD_NUMBER

      public static final int LEADING_DETACHED_COMMENTS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPathList

      public List<Integer> getPathList()
       Identifies which part of the FileDescriptorProto was defined at this
 location.

 Each element is a field number or an index.  They form a path from
 the root FileDescriptorProto to the place where the definition appears.
 For example, this path:
 [ 4, 3, 2, 7, 1 ]
 refers to:
 file.message_type(3)  // 4, 3
 .field(7)         // 2, 7
 .name()           // 1
 This is because FileDescriptorProto.message_type has field number 4:
 repeated DescriptorProto message_type = 4;
 and DescriptorProto.field has field number 2:
 repeated FieldDescriptorProto field = 2;
 and FieldDescriptorProto.name has field number 1:
 optional string name = 1;

 Thus, the above path gives the location of a field name.  If we removed
 the last element:
 [ 4, 3, 2, 7 ]
 this path refers to the whole field declaration (from the beginning
 of the label to the terminating semicolon).
      repeated int32 path = 1 [packed = true];
      Specified by:
      getPathList in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      A list containing the path.

    • getPathCount

      public int getPathCount()
       Identifies which part of the FileDescriptorProto was defined at this
 location.

 Each element is a field number or an index.  They form a path from
 the root FileDescriptorProto to the place where the definition appears.
 For example, this path:
 [ 4, 3, 2, 7, 1 ]
 refers to:
 file.message_type(3)  // 4, 3
 .field(7)         // 2, 7
 .name()           // 1
 This is because FileDescriptorProto.message_type has field number 4:
 repeated DescriptorProto message_type = 4;
 and DescriptorProto.field has field number 2:
 repeated FieldDescriptorProto field = 2;
 and FieldDescriptorProto.name has field number 1:
 optional string name = 1;

 Thus, the above path gives the location of a field name.  If we removed
 the last element:
 [ 4, 3, 2, 7 ]
 this path refers to the whole field declaration (from the beginning
 of the label to the terminating semicolon).
      repeated int32 path = 1 [packed = true];
      Specified by:
      getPathCount in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      The count of path.

    • getPath

      public int getPath(int index)
       Identifies which part of the FileDescriptorProto was defined at this
 location.

 Each element is a field number or an index.  They form a path from
 the root FileDescriptorProto to the place where the definition appears.
 For example, this path:
 [ 4, 3, 2, 7, 1 ]
 refers to:
 file.message_type(3)  // 4, 3
 .field(7)         // 2, 7
 .name()           // 1
 This is because FileDescriptorProto.message_type has field number 4:
 repeated DescriptorProto message_type = 4;
 and DescriptorProto.field has field number 2:
 repeated FieldDescriptorProto field = 2;
 and FieldDescriptorProto.name has field number 1:
 optional string name = 1;

 Thus, the above path gives the location of a field name.  If we removed
 the last element:
 [ 4, 3, 2, 7 ]
 this path refers to the whole field declaration (from the beginning
 of the label to the terminating semicolon).
      repeated int32 path = 1 [packed = true];
      Specified by:
      getPath in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The path at the given index.

    • getSpanList

      public List<Integer> getSpanList()
       Always has exactly three or four elements: start line, start column,
 end line (optional, otherwise assumed same as start line), end column.
 These are packed into a single field for efficiency.  Note that line
 and column numbers are zero-based -- typically you will want to add
 1 to each before displaying to a user.
      repeated int32 span = 2 [packed = true];
      Specified by:
      getSpanList in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      A list containing the span.

    • getSpanCount

      public int getSpanCount()
       Always has exactly three or four elements: start line, start column,
 end line (optional, otherwise assumed same as start line), end column.
 These are packed into a single field for efficiency.  Note that line
 and column numbers are zero-based -- typically you will want to add
 1 to each before displaying to a user.
      repeated int32 span = 2 [packed = true];
      Specified by:
      getSpanCount in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      The count of span.

    • getSpan

      public int getSpan(int index)
       Always has exactly three or four elements: start line, start column,
 end line (optional, otherwise assumed same as start line), end column.
 These are packed into a single field for efficiency.  Note that line
 and column numbers are zero-based -- typically you will want to add
 1 to each before displaying to a user.
      repeated int32 span = 2 [packed = true];
      Specified by:
      getSpan in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The span at the given index.

    • hasLeadingComments

      public boolean hasLeadingComments()
       If this SourceCodeInfo represents a complete declaration, these are any
 comments appearing before and after the declaration which appear to be
 attached to the declaration.

 A series of line comments appearing on consecutive lines, with no other
 tokens appearing on those lines, will be treated as a single comment.

 leading_detached_comments will keep paragraphs of comments that appear
 before (but not connected to) the current element. Each paragraph,
 separated by empty lines, will be one comment element in the repeated
 field.

 Only the comment content is provided; comment markers (e.g. //) are
 stripped out.  For block comments, leading whitespace and an asterisk
 will be stripped from the beginning of each line other than the first.
 Newlines are included in the output.

 Examples:

 optional int32 foo = 1;  // Comment attached to foo.
 // Comment attached to bar.
 optional int32 bar = 2;

 optional string baz = 3;
 // Comment attached to baz.
 // Another line attached to baz.

 // Comment attached to moo.
 //
 // Another line attached to moo.
 optional double moo = 4;

 // Detached comment for corge. This is not leading or trailing comments
 // to moo or corge because there are blank lines separating it from
 // both.

 // Detached comment for corge paragraph 2.

 optional string corge = 5;
 /* Block comment attached
 * to corge.  Leading asterisks
 * will be removed. */
 /* Block comment attached to
 * grault. */
 optional int32 grault = 6;

 // ignored detached comments.
      optional string leading_comments = 3;
      Specified by:
      hasLeadingComments in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      Whether the leadingComments field is set.

    • getLeadingComments

      public String getLeadingComments()
       If this SourceCodeInfo represents a complete declaration, these are any
 comments appearing before and after the declaration which appear to be
 attached to the declaration.

 A series of line comments appearing on consecutive lines, with no other
 tokens appearing on those lines, will be treated as a single comment.

 leading_detached_comments will keep paragraphs of comments that appear
 before (but not connected to) the current element. Each paragraph,
 separated by empty lines, will be one comment element in the repeated
 field.

 Only the comment content is provided; comment markers (e.g. //) are
 stripped out.  For block comments, leading whitespace and an asterisk
 will be stripped from the beginning of each line other than the first.
 Newlines are included in the output.

 Examples:

 optional int32 foo = 1;  // Comment attached to foo.
 // Comment attached to bar.
 optional int32 bar = 2;

 optional string baz = 3;
 // Comment attached to baz.
 // Another line attached to baz.

 // Comment attached to moo.
 //
 // Another line attached to moo.
 optional double moo = 4;

 // Detached comment for corge. This is not leading or trailing comments
 // to moo or corge because there are blank lines separating it from
 // both.

 // Detached comment for corge paragraph 2.

 optional string corge = 5;
 /* Block comment attached
 * to corge.  Leading asterisks
 * will be removed. */
 /* Block comment attached to
 * grault. */
 optional int32 grault = 6;

 // ignored detached comments.
      optional string leading_comments = 3;
      Specified by:
      getLeadingComments in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      The leadingComments.

    • getLeadingCommentsBytes

      public com.google.protobuf.ByteString getLeadingCommentsBytes()
       If this SourceCodeInfo represents a complete declaration, these are any
 comments appearing before and after the declaration which appear to be
 attached to the declaration.

 A series of line comments appearing on consecutive lines, with no other
 tokens appearing on those lines, will be treated as a single comment.

 leading_detached_comments will keep paragraphs of comments that appear
 before (but not connected to) the current element. Each paragraph,
 separated by empty lines, will be one comment element in the repeated
 field.

 Only the comment content is provided; comment markers (e.g. //) are
 stripped out.  For block comments, leading whitespace and an asterisk
 will be stripped from the beginning of each line other than the first.
 Newlines are included in the output.

 Examples:

 optional int32 foo = 1;  // Comment attached to foo.
 // Comment attached to bar.
 optional int32 bar = 2;

 optional string baz = 3;
 // Comment attached to baz.
 // Another line attached to baz.

 // Comment attached to moo.
 //
 // Another line attached to moo.
 optional double moo = 4;

 // Detached comment for corge. This is not leading or trailing comments
 // to moo or corge because there are blank lines separating it from
 // both.

 // Detached comment for corge paragraph 2.

 optional string corge = 5;
 /* Block comment attached
 * to corge.  Leading asterisks
 * will be removed. */
 /* Block comment attached to
 * grault. */
 optional int32 grault = 6;

 // ignored detached comments.
      optional string leading_comments = 3;
      Specified by:
      getLeadingCommentsBytes in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      The bytes for leadingComments.

    • hasTrailingComments

      public boolean hasTrailingComments()
      optional string trailing_comments = 4;
      Specified by:
      hasTrailingComments in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      Whether the trailingComments field is set.

    • getTrailingComments

      public String getTrailingComments()
      optional string trailing_comments = 4;
      Specified by:
      getTrailingComments in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      The trailingComments.

    • getTrailingCommentsBytes

      public com.google.protobuf.ByteString getTrailingCommentsBytes()
      optional string trailing_comments = 4;
      Specified by:
      getTrailingCommentsBytes in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      The bytes for trailingComments.

    • getLeadingDetachedCommentsList

      public com.google.protobuf.ProtocolStringList getLeadingDetachedCommentsList()
      repeated string leading_detached_comments = 6;
      Specified by:
      getLeadingDetachedCommentsList in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      A list containing the leadingDetachedComments.

    • getLeadingDetachedCommentsCount

      public int getLeadingDetachedCommentsCount()
      repeated string leading_detached_comments = 6;
      Specified by:
      getLeadingDetachedCommentsCount in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Returns:
      The count of leadingDetachedComments.

    • getLeadingDetachedComments

      public String getLeadingDetachedComments(int index)
      repeated string leading_detached_comments = 6;
      Specified by:
      getLeadingDetachedComments in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The leadingDetachedComments at the given index.

    • getLeadingDetachedCommentsBytes

      public com.google.protobuf.ByteString getLeadingDetachedCommentsBytes(int index)
      repeated string leading_detached_comments = 6;
      Specified by:
      getLeadingDetachedCommentsBytes in interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the leadingDetachedComments at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescriptorProtos.SourceCodeInfo.Location parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DescriptorProtos.SourceCodeInfo.Location.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DescriptorProtos.SourceCodeInfo.Location.Builder newBuilder()

    • newBuilder

      public static DescriptorProtos.SourceCodeInfo.Location.Builder newBuilder(DescriptorProtos.SourceCodeInfo.Location prototype)

    • toBuilder

      public DescriptorProtos.SourceCodeInfo.Location.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DescriptorProtos.SourceCodeInfo.Location.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DescriptorProtos.SourceCodeInfo.Location getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DescriptorProtos.SourceCodeInfo.Location> parser()

    • getParserForType

      public com.google.protobuf.Parser<DescriptorProtos.SourceCodeInfo.Location> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public DescriptorProtos.SourceCodeInfo.Location getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder