Interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder

public static interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getLeadingComments()

public abstract 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 qux.
//
// Another line attached to qux.
optional double qux = 4;
// Detached comment for corge. This is not leading or trailing comments
// to qux 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;

Returns
TypeDescription
String

The leadingComments.

getLeadingCommentsBytes()

public abstract 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 qux.
//
// Another line attached to qux.
optional double qux = 4;
// Detached comment for corge. This is not leading or trailing comments
// to qux 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;

Returns
TypeDescription
ByteString

The bytes for leadingComments.

getLeadingDetachedComments(int index)

public abstract String getLeadingDetachedComments(int index)

repeated string leading_detached_comments = 6;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The leadingDetachedComments at the given index.

getLeadingDetachedCommentsBytes(int index)

public abstract ByteString getLeadingDetachedCommentsBytes(int index)

repeated string leading_detached_comments = 6;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the leadingDetachedComments at the given index.

getLeadingDetachedCommentsCount()

public abstract int getLeadingDetachedCommentsCount()

repeated string leading_detached_comments = 6;

Returns
TypeDescription
int

The count of leadingDetachedComments.

getLeadingDetachedCommentsList()

public abstract List<String> getLeadingDetachedCommentsList()

repeated string leading_detached_comments = 6;

Returns
TypeDescription
List<String>

A list containing the leadingDetachedComments.

getPath(int index)

public abstract 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. 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];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
int

The path at the given index.

getPathCount()

public abstract 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. 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];

Returns
TypeDescription
int

The count of path.

getPathList()

public abstract 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. 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];

Returns
TypeDescription
List<Integer>

A list containing the path.

getSpan(int index)

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
int

The span at the given index.

getSpanCount()

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

Returns
TypeDescription
int

The count of span.

getSpanList()

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

Returns
TypeDescription
List<Integer>

A list containing the span.

getTrailingComments()

public abstract String getTrailingComments()

optional string trailing_comments = 4;

Returns
TypeDescription
String

The trailingComments.

getTrailingCommentsBytes()

public abstract ByteString getTrailingCommentsBytes()

optional string trailing_comments = 4;

Returns
TypeDescription
ByteString

The bytes for trailingComments.

hasLeadingComments()

public abstract 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 qux.
//
// Another line attached to qux.
optional double qux = 4;
// Detached comment for corge. This is not leading or trailing comments
// to qux 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;

Returns
TypeDescription
boolean

Whether the leadingComments field is set.

hasTrailingComments()

public abstract boolean hasTrailingComments()

optional string trailing_comments = 4;

Returns
TypeDescription
boolean

Whether the trailingComments field is set.