Package com.google.devtools.build.lib.starlarkdocextract

Class StardocOutputProtos.FunctionParamInfo

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.devtools.build.lib.starlarkdocextract.StardocOutputProtos.FunctionParamInfo

All Implemented Interfaces:

StardocOutputProtos.FunctionParamInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

StardocOutputProtos

public static final class StardocOutputProtos.FunctionParamInfo
extends com.google.protobuf.GeneratedMessage
implements StardocOutputProtos.FunctionParamInfoOrBuilder

 Representation of a Starlark function parameter definition.
 

Protobuf type stardoc_output.FunctionParamInfo

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StardocOutputProtos.FunctionParamInfo.Builder	Representation of a Starlark function parameter definition.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_VALUE_FIELD_NUMBER
static final int	DOC_STRING_FIELD_NUMBER
static final int	MANDATORY_FIELD_NUMBER
static final int	NAME_FIELD_NUMBER
static final int	ROLE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static StardocOutputProtos.FunctionParamInfo	getDefaultInstance()
StardocOutputProtos.FunctionParamInfo	getDefaultInstanceForType()
String	getDefaultValue()	If not an empty string, the default value of the parameter displayed as a string.
com.google.protobuf.ByteString	getDefaultValueBytes()	If not an empty string, the default value of the parameter displayed as a string.
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDocString()	The documented description of the parameter (if specified in the function's docstring).
com.google.protobuf.ByteString	getDocStringBytes()	The documented description of the parameter (if specified in the function's docstring).
boolean	getMandatory()	If true, the default value is unset and a value is needed for this parameter.
String	getName()	The name of the parameter.
com.google.protobuf.ByteString	getNameBytes()	The name of the parameter.
com.google.protobuf.Parser<StardocOutputProtos.FunctionParamInfo>	getParserForType()
StardocOutputProtos.FunctionParamRole	getRole()	The parameter's syntactic role.
int	getRoleValue()	The parameter's syntactic role.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static StardocOutputProtos.FunctionParamInfo.Builder	newBuilder()
static StardocOutputProtos.FunctionParamInfo.Builder	newBuilder(StardocOutputProtos.FunctionParamInfo prototype)
StardocOutputProtos.FunctionParamInfo.Builder	newBuilderForType()
protected StardocOutputProtos.FunctionParamInfo.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static StardocOutputProtos.FunctionParamInfo	parseDelimitedFrom(InputStream input)
static StardocOutputProtos.FunctionParamInfo	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StardocOutputProtos.FunctionParamInfo	parseFrom(byte[] data)
static StardocOutputProtos.FunctionParamInfo	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StardocOutputProtos.FunctionParamInfo	parseFrom(com.google.protobuf.ByteString data)
static StardocOutputProtos.FunctionParamInfo	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StardocOutputProtos.FunctionParamInfo	parseFrom(com.google.protobuf.CodedInputStream input)
static StardocOutputProtos.FunctionParamInfo	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StardocOutputProtos.FunctionParamInfo	parseFrom(InputStream input)
static StardocOutputProtos.FunctionParamInfo	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StardocOutputProtos.FunctionParamInfo	parseFrom(ByteBuffer data)
static StardocOutputProtos.FunctionParamInfo	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StardocOutputProtos.FunctionParamInfo>	parser()
StardocOutputProtos.FunctionParamInfo.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

• Constant Field Values

DOC_STRING_FIELD_NUMBER

public static final int DOC_STRING_FIELD_NUMBER

See Also:

• Constant Field Values

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

MANDATORY_FIELD_NUMBER

public static final int MANDATORY_FIELD_NUMBER

See Also:

• Constant Field Values

ROLE_FIELD_NUMBER

public static final int ROLE_FIELD_NUMBER

See Also:

• Constant Field Values

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

getName

public String getName()

 The name of the parameter. This does *not* include the `*` or `**` prefix
 for varargs or residual keyword argument parameters.
 

string name = 1;

Specified by:

getName in interface StardocOutputProtos.FunctionParamInfoOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The name of the parameter. This does *not* include the `*` or `**` prefix
 for varargs or residual keyword argument parameters.
 

string name = 1;

Specified by:

getNameBytes in interface StardocOutputProtos.FunctionParamInfoOrBuilder

Returns:

The bytes for name.

getDocString

public String getDocString()

 The documented description of the parameter (if specified in the function's
 docstring).
 

string doc_string = 2;

Specified by:

getDocString in interface StardocOutputProtos.FunctionParamInfoOrBuilder

Returns:

The docString.

getDocStringBytes

public com.google.protobuf.ByteString getDocStringBytes()

 The documented description of the parameter (if specified in the function's
 docstring).
 

string doc_string = 2;

Specified by:

getDocStringBytes in interface StardocOutputProtos.FunctionParamInfoOrBuilder

Returns:

The bytes for docString.

getDefaultValue

public String getDefaultValue()

 If not an empty string, the default value of the parameter displayed
 as a string.
 

string default_value = 3;

Specified by:

getDefaultValue in interface StardocOutputProtos.FunctionParamInfoOrBuilder

Returns:

The defaultValue.

getDefaultValueBytes

public com.google.protobuf.ByteString getDefaultValueBytes()

 If not an empty string, the default value of the parameter displayed
 as a string.
 

string default_value = 3;

Specified by:

getDefaultValueBytes in interface StardocOutputProtos.FunctionParamInfoOrBuilder

Returns:

The bytes for defaultValue.

getMandatory

public boolean getMandatory()

 If true, the default value is unset and a value is needed for this
 parameter. This might be false even if defaultValue is empty in the case of
 special parameter such as *args and **kwargs"
 

bool mandatory = 4;

Specified by:

getMandatory in interface StardocOutputProtos.FunctionParamInfoOrBuilder

Returns:

The mandatory.

getRoleValue

public int getRoleValue()

 The parameter's syntactic role.
 

.stardoc_output.FunctionParamRole role = 5;

Specified by:

getRoleValue in interface StardocOutputProtos.FunctionParamInfoOrBuilder

Returns:

The enum numeric value on the wire for role.

getRole

public StardocOutputProtos.FunctionParamRole getRole()

 The parameter's syntactic role.
 

.stardoc_output.FunctionParamRole role = 5;

Specified by:

getRole in interface StardocOutputProtos.FunctionParamInfoOrBuilder

Returns:

The role.

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 StardocOutputProtos.FunctionParamInfo parseFrom(ByteBuffer data)
                                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StardocOutputProtos.FunctionParamInfo parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StardocOutputProtos.FunctionParamInfo parseFrom(com.google.protobuf.ByteString data)
                                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StardocOutputProtos.FunctionParamInfo parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StardocOutputProtos.FunctionParamInfo parseFrom(byte[] data)
                                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StardocOutputProtos.FunctionParamInfo parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StardocOutputProtos.FunctionParamInfo parseFrom(InputStream input)
                                                       throws IOException

Throws:

IOException

parseFrom

public static StardocOutputProtos.FunctionParamInfo parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static StardocOutputProtos.FunctionParamInfo parseDelimitedFrom(InputStream input)
                                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static StardocOutputProtos.FunctionParamInfo parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                throws IOException

Throws:

IOException

parseFrom

public static StardocOutputProtos.FunctionParamInfo parseFrom(com.google.protobuf.CodedInputStream input)
                                                       throws IOException

Throws:

IOException

parseFrom

public static StardocOutputProtos.FunctionParamInfo parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws IOException

Throws:

IOException

newBuilderForType

public StardocOutputProtos.FunctionParamInfo.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StardocOutputProtos.FunctionParamInfo.Builder newBuilder()

newBuilder

public static StardocOutputProtos.FunctionParamInfo.Builder newBuilder(StardocOutputProtos.FunctionParamInfo prototype)

toBuilder

public StardocOutputProtos.FunctionParamInfo.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected StardocOutputProtos.FunctionParamInfo.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static StardocOutputProtos.FunctionParamInfo getDefaultInstance()

parser

public static com.google.protobuf.Parser<StardocOutputProtos.FunctionParamInfo> parser()

getParserForType

public com.google.protobuf.Parser<StardocOutputProtos.FunctionParamInfo> 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 StardocOutputProtos.FunctionParamInfo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder