Class StardocOutputProtos.FunctionParamInfo.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<StardocOutputProtos.FunctionParamInfo.Builder>
com.google.devtools.build.lib.starlarkdocextract.StardocOutputProtos.FunctionParamInfo.Builder
- All Implemented Interfaces:
StardocOutputProtos.FunctionParamInfoOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- StardocOutputProtos.FunctionParamInfo
public static final class StardocOutputProtos.FunctionParamInfo.Builder
extends com.google.protobuf.GeneratedMessage.Builder<StardocOutputProtos.FunctionParamInfo.Builder>
implements StardocOutputProtos.FunctionParamInfoOrBuilder
Representation of a Starlark function parameter definition.Protobuf type
stardoc_output.FunctionParamInfo-
Method Summary
Modifier and TypeMethodDescriptionbuild()clear()If not an empty string, the default value of the parameter displayed as a string.The documented description of the parameter (if specified in the function's docstring).If true, the default value is unset and a value is needed for this parameter.The name of the parameter.The parameter's syntactic role.If not an empty string, the default value of the parameter displayed as a string.com.google.protobuf.ByteStringIf not an empty string, the default value of the parameter displayed as a string.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorThe documented description of the parameter (if specified in the function's docstring).com.google.protobuf.ByteStringThe documented description of the parameter (if specified in the function's docstring).booleanIf true, the default value is unset and a value is needed for this parameter.getName()The name of the parameter.com.google.protobuf.ByteStringThe name of the parameter.getRole()The parameter's syntactic role.intThe parameter's syntactic role.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) setDefaultValue(String value) If not an empty string, the default value of the parameter displayed as a string.setDefaultValueBytes(com.google.protobuf.ByteString value) If not an empty string, the default value of the parameter displayed as a string.setDocString(String value) The documented description of the parameter (if specified in the function's docstring).setDocStringBytes(com.google.protobuf.ByteString value) The documented description of the parameter (if specified in the function's docstring).setMandatory(boolean value) If true, the default value is unset and a value is needed for this parameter.The name of the parameter.setNameBytes(com.google.protobuf.ByteString value) The name of the parameter.The parameter's syntactic role.setRoleValue(int value) The parameter's syntactic role.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<StardocOutputProtos.FunctionParamInfo.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<StardocOutputProtos.FunctionParamInfo.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<StardocOutputProtos.FunctionParamInfo.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<StardocOutputProtos.FunctionParamInfo.Builder>
-
mergeFrom
public StardocOutputProtos.FunctionParamInfo.Builder mergeFrom(StardocOutputProtos.FunctionParamInfo other) -
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<StardocOutputProtos.FunctionParamInfo.Builder>
-
mergeFrom
public StardocOutputProtos.FunctionParamInfo.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<StardocOutputProtos.FunctionParamInfo.Builder>- Throws:
IOException
-
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:
getNamein interfaceStardocOutputProtos.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:
getNameBytesin interfaceStardocOutputProtos.FunctionParamInfoOrBuilder- Returns:
- The bytes for name.
-
setName
The name of the parameter. This does *not* include the `*` or `**` prefix for varargs or residual keyword argument parameters.
string name = 1;- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
The name of the parameter. This does *not* include the `*` or `**` prefix for varargs or residual keyword argument parameters.
string name = 1;- Returns:
- This builder for chaining.
-
setNameBytes
public StardocOutputProtos.FunctionParamInfo.Builder setNameBytes(com.google.protobuf.ByteString value) The name of the parameter. This does *not* include the `*` or `**` prefix for varargs or residual keyword argument parameters.
string name = 1;- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
getDocString
The documented description of the parameter (if specified in the function's docstring).
string doc_string = 2;- Specified by:
getDocStringin interfaceStardocOutputProtos.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:
getDocStringBytesin interfaceStardocOutputProtos.FunctionParamInfoOrBuilder- Returns:
- The bytes for docString.
-
setDocString
The documented description of the parameter (if specified in the function's docstring).
string doc_string = 2;- Parameters:
value- The docString to set.- Returns:
- This builder for chaining.
-
clearDocString
The documented description of the parameter (if specified in the function's docstring).
string doc_string = 2;- Returns:
- This builder for chaining.
-
setDocStringBytes
public StardocOutputProtos.FunctionParamInfo.Builder setDocStringBytes(com.google.protobuf.ByteString value) The documented description of the parameter (if specified in the function's docstring).
string doc_string = 2;- Parameters:
value- The bytes for docString to set.- Returns:
- This builder for chaining.
-
getDefaultValue
If not an empty string, the default value of the parameter displayed as a string.
string default_value = 3;- Specified by:
getDefaultValuein interfaceStardocOutputProtos.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:
getDefaultValueBytesin interfaceStardocOutputProtos.FunctionParamInfoOrBuilder- Returns:
- The bytes for defaultValue.
-
setDefaultValue
If not an empty string, the default value of the parameter displayed as a string.
string default_value = 3;- Parameters:
value- The defaultValue to set.- Returns:
- This builder for chaining.
-
clearDefaultValue
If not an empty string, the default value of the parameter displayed as a string.
string default_value = 3;- Returns:
- This builder for chaining.
-
setDefaultValueBytes
public StardocOutputProtos.FunctionParamInfo.Builder setDefaultValueBytes(com.google.protobuf.ByteString value) If not an empty string, the default value of the parameter displayed as a string.
string default_value = 3;- Parameters:
value- The bytes for defaultValue to set.- Returns:
- This builder for chaining.
-
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:
getMandatoryin interfaceStardocOutputProtos.FunctionParamInfoOrBuilder- Returns:
- The mandatory.
-
setMandatory
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;- Parameters:
value- The mandatory to set.- Returns:
- This builder for chaining.
-
clearMandatory
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;- Returns:
- This builder for chaining.
-
getRoleValue
public int getRoleValue()The parameter's syntactic role.
.stardoc_output.FunctionParamRole role = 5;- Specified by:
getRoleValuein interfaceStardocOutputProtos.FunctionParamInfoOrBuilder- Returns:
- The enum numeric value on the wire for role.
-
setRoleValue
The parameter's syntactic role.
.stardoc_output.FunctionParamRole role = 5;- Parameters:
value- The enum numeric value on the wire for role to set.- Returns:
- This builder for chaining.
-
getRole
The parameter's syntactic role.
.stardoc_output.FunctionParamRole role = 5;- Specified by:
getRolein interfaceStardocOutputProtos.FunctionParamInfoOrBuilder- Returns:
- The role.
-
setRole
public StardocOutputProtos.FunctionParamInfo.Builder setRole(StardocOutputProtos.FunctionParamRole value) The parameter's syntactic role.
.stardoc_output.FunctionParamRole role = 5;- Parameters:
value- The role to set.- Returns:
- This builder for chaining.
-
clearRole
The parameter's syntactic role.
.stardoc_output.FunctionParamRole role = 5;- Returns:
- This builder for chaining.
-