Class StardocOutputProtos.StarlarkFunctionInfo.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<StardocOutputProtos.StarlarkFunctionInfo.Builder>
com.google.devtools.build.lib.starlarkdocextract.StardocOutputProtos.StarlarkFunctionInfo.Builder
- All Implemented Interfaces:
StardocOutputProtos.StarlarkFunctionInfoOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- StardocOutputProtos.StarlarkFunctionInfo
public static final class StardocOutputProtos.StarlarkFunctionInfo.Builder
extends com.google.protobuf.GeneratedMessage.Builder<StardocOutputProtos.StarlarkFunctionInfo.Builder>
implements StardocOutputProtos.StarlarkFunctionInfoOrBuilder
Representation of Starlark function definition.Protobuf type
stardoc_output.StarlarkFunctionInfo-
Method Summary
Modifier and TypeMethodDescriptionaddAllParameter(Iterable<? extends StardocOutputProtos.FunctionParamInfo> values) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).addParameter(int index, StardocOutputProtos.FunctionParamInfo value) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).addParameter(int index, StardocOutputProtos.FunctionParamInfo.Builder builderForValue) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).addParameter(StardocOutputProtos.FunctionParamInfo.Builder builderForValue) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).addParameterBuilder(int index) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).build()clear()The deprecation for the function.The documented description of the function (if specified in the function's docstring).The name under which the function is made accessible to a user of this module, including any structs it is nested in, for example "foo.frobnicate".The module where and the name under which the function was originally declared.The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).The return value for the function.The deprecation for the function.The deprecation for the function.The deprecation for the function.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorThe documented description of the function (if specified in the function's docstring).com.google.protobuf.ByteStringThe documented description of the function (if specified in the function's docstring).The name under which the function is made accessible to a user of this module, including any structs it is nested in, for example "foo.frobnicate".com.google.protobuf.ByteStringThe name under which the function is made accessible to a user of this module, including any structs it is nested in, for example "foo.frobnicate".The module where and the name under which the function was originally declared.The module where and the name under which the function was originally declared.The module where and the name under which the function was originally declared.getParameter(int index) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).getParameterBuilder(int index) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).intThe parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).getParameterOrBuilder(int index) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).The return value for the function.The return value for the function.The return value for the function.booleanThe deprecation for the function.booleanThe module where and the name under which the function was originally declared.booleanThe return value for the function.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanThe deprecation for the function.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) The module where and the name under which the function was originally declared.The return value for the function.removeParameter(int index) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).The deprecation for the function.setDeprecated(StardocOutputProtos.FunctionDeprecationInfo.Builder builderForValue) The deprecation for the function.setDocString(String value) The documented description of the function (if specified in the function's docstring).setDocStringBytes(com.google.protobuf.ByteString value) The documented description of the function (if specified in the function's docstring).setFunctionName(String value) The name under which the function is made accessible to a user of this module, including any structs it is nested in, for example "foo.frobnicate".setFunctionNameBytes(com.google.protobuf.ByteString value) The name under which the function is made accessible to a user of this module, including any structs it is nested in, for example "foo.frobnicate".The module where and the name under which the function was originally declared.setOriginKey(StardocOutputProtos.OriginKey.Builder builderForValue) The module where and the name under which the function was originally declared.setParameter(int index, StardocOutputProtos.FunctionParamInfo value) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).setParameter(int index, StardocOutputProtos.FunctionParamInfo.Builder builderForValue) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`).The return value for the function.setReturn(StardocOutputProtos.FunctionReturnInfo.Builder builderForValue) The return value for the function.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.StarlarkFunctionInfo.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.StarlarkFunctionInfo.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.StarlarkFunctionInfo.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
public StardocOutputProtos.StarlarkFunctionInfo.Builder mergeFrom(com.google.protobuf.Message other) - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<StardocOutputProtos.StarlarkFunctionInfo.Builder>
-
mergeFrom
public StardocOutputProtos.StarlarkFunctionInfo.Builder mergeFrom(StardocOutputProtos.StarlarkFunctionInfo other) -
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<StardocOutputProtos.StarlarkFunctionInfo.Builder>
-
mergeFrom
public StardocOutputProtos.StarlarkFunctionInfo.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.StarlarkFunctionInfo.Builder>- Throws:
IOException
-
getFunctionName
The name under which the function is made accessible to a user of this module, including any structs it is nested in, for example "foo.frobnicate".
string function_name = 1;- Specified by:
getFunctionNamein interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder- Returns:
- The functionName.
-
getFunctionNameBytes
public com.google.protobuf.ByteString getFunctionNameBytes()The name under which the function is made accessible to a user of this module, including any structs it is nested in, for example "foo.frobnicate".
string function_name = 1;- Specified by:
getFunctionNameBytesin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder- Returns:
- The bytes for functionName.
-
setFunctionName
The name under which the function is made accessible to a user of this module, including any structs it is nested in, for example "foo.frobnicate".
string function_name = 1;- Parameters:
value- The functionName to set.- Returns:
- This builder for chaining.
-
clearFunctionName
The name under which the function is made accessible to a user of this module, including any structs it is nested in, for example "foo.frobnicate".
string function_name = 1;- Returns:
- This builder for chaining.
-
setFunctionNameBytes
public StardocOutputProtos.StarlarkFunctionInfo.Builder setFunctionNameBytes(com.google.protobuf.ByteString value) The name under which the function is made accessible to a user of this module, including any structs it is nested in, for example "foo.frobnicate".
string function_name = 1;- Parameters:
value- The bytes for functionName to set.- Returns:
- This builder for chaining.
-
getParameterList
The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2;- Specified by:
getParameterListin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder
-
getParameterCount
public int getParameterCount()The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2;- Specified by:
getParameterCountin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder
-
getParameter
The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2;- Specified by:
getParameterin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder
-
setParameter
public StardocOutputProtos.StarlarkFunctionInfo.Builder setParameter(int index, StardocOutputProtos.FunctionParamInfo value) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
setParameter
public StardocOutputProtos.StarlarkFunctionInfo.Builder setParameter(int index, StardocOutputProtos.FunctionParamInfo.Builder builderForValue) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
addParameter
public StardocOutputProtos.StarlarkFunctionInfo.Builder addParameter(StardocOutputProtos.FunctionParamInfo value) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
addParameter
public StardocOutputProtos.StarlarkFunctionInfo.Builder addParameter(int index, StardocOutputProtos.FunctionParamInfo value) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
addParameter
public StardocOutputProtos.StarlarkFunctionInfo.Builder addParameter(StardocOutputProtos.FunctionParamInfo.Builder builderForValue) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
addParameter
public StardocOutputProtos.StarlarkFunctionInfo.Builder addParameter(int index, StardocOutputProtos.FunctionParamInfo.Builder builderForValue) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
addAllParameter
public StardocOutputProtos.StarlarkFunctionInfo.Builder addAllParameter(Iterable<? extends StardocOutputProtos.FunctionParamInfo> values) The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
clearParameter
The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
removeParameter
The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
getParameterBuilder
The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
getParameterOrBuilder
The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2;- Specified by:
getParameterOrBuilderin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder
-
getParameterOrBuilderList
The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2;- Specified by:
getParameterOrBuilderListin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder
-
addParameterBuilder
The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
addParameterBuilder
The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
getParameterBuilderList
The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.
repeated .stardoc_output.FunctionParamInfo parameter = 2; -
getDocString
The documented description of the function (if specified in the function's docstring).
string doc_string = 3;- Specified by:
getDocStringin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder- Returns:
- The docString.
-
getDocStringBytes
public com.google.protobuf.ByteString getDocStringBytes()The documented description of the function (if specified in the function's docstring).
string doc_string = 3;- Specified by:
getDocStringBytesin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder- Returns:
- The bytes for docString.
-
setDocString
The documented description of the function (if specified in the function's docstring).
string doc_string = 3;- Parameters:
value- The docString to set.- Returns:
- This builder for chaining.
-
clearDocString
The documented description of the function (if specified in the function's docstring).
string doc_string = 3;- Returns:
- This builder for chaining.
-
setDocStringBytes
public StardocOutputProtos.StarlarkFunctionInfo.Builder setDocStringBytes(com.google.protobuf.ByteString value) The documented description of the function (if specified in the function's docstring).
string doc_string = 3;- Parameters:
value- The bytes for docString to set.- Returns:
- This builder for chaining.
-
hasReturn
public boolean hasReturn()The return value for the function.
.stardoc_output.FunctionReturnInfo return = 4;- Specified by:
hasReturnin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder- Returns:
- Whether the return field is set.
-
getReturn
The return value for the function.
.stardoc_output.FunctionReturnInfo return = 4;- Specified by:
getReturnin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder- Returns:
- The return.
-
setReturn
public StardocOutputProtos.StarlarkFunctionInfo.Builder setReturn(StardocOutputProtos.FunctionReturnInfo value) The return value for the function.
.stardoc_output.FunctionReturnInfo return = 4; -
setReturn
public StardocOutputProtos.StarlarkFunctionInfo.Builder setReturn(StardocOutputProtos.FunctionReturnInfo.Builder builderForValue) The return value for the function.
.stardoc_output.FunctionReturnInfo return = 4; -
mergeReturn
public StardocOutputProtos.StarlarkFunctionInfo.Builder mergeReturn(StardocOutputProtos.FunctionReturnInfo value) The return value for the function.
.stardoc_output.FunctionReturnInfo return = 4; -
clearReturn
The return value for the function.
.stardoc_output.FunctionReturnInfo return = 4; -
getReturnBuilder
The return value for the function.
.stardoc_output.FunctionReturnInfo return = 4; -
getReturnOrBuilder
The return value for the function.
.stardoc_output.FunctionReturnInfo return = 4;- Specified by:
getReturnOrBuilderin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder
-
hasDeprecated
public boolean hasDeprecated()The deprecation for the function.
.stardoc_output.FunctionDeprecationInfo deprecated = 5;- Specified by:
hasDeprecatedin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder- Returns:
- Whether the deprecated field is set.
-
getDeprecated
The deprecation for the function.
.stardoc_output.FunctionDeprecationInfo deprecated = 5;- Specified by:
getDeprecatedin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder- Returns:
- The deprecated.
-
setDeprecated
public StardocOutputProtos.StarlarkFunctionInfo.Builder setDeprecated(StardocOutputProtos.FunctionDeprecationInfo value) The deprecation for the function.
.stardoc_output.FunctionDeprecationInfo deprecated = 5; -
setDeprecated
public StardocOutputProtos.StarlarkFunctionInfo.Builder setDeprecated(StardocOutputProtos.FunctionDeprecationInfo.Builder builderForValue) The deprecation for the function.
.stardoc_output.FunctionDeprecationInfo deprecated = 5; -
mergeDeprecated
public StardocOutputProtos.StarlarkFunctionInfo.Builder mergeDeprecated(StardocOutputProtos.FunctionDeprecationInfo value) The deprecation for the function.
.stardoc_output.FunctionDeprecationInfo deprecated = 5; -
clearDeprecated
The deprecation for the function.
.stardoc_output.FunctionDeprecationInfo deprecated = 5; -
getDeprecatedBuilder
The deprecation for the function.
.stardoc_output.FunctionDeprecationInfo deprecated = 5; -
getDeprecatedOrBuilder
The deprecation for the function.
.stardoc_output.FunctionDeprecationInfo deprecated = 5;- Specified by:
getDeprecatedOrBuilderin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder
-
hasOriginKey
public boolean hasOriginKey()The module where and the name under which the function was originally declared. Note: legacy Stardoc (0.5.x and earlier) does not set this field.
.stardoc_output.OriginKey origin_key = 6;- Specified by:
hasOriginKeyin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder- Returns:
- Whether the originKey field is set.
-
getOriginKey
The module where and the name under which the function was originally declared. Note: legacy Stardoc (0.5.x and earlier) does not set this field.
.stardoc_output.OriginKey origin_key = 6;- Specified by:
getOriginKeyin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder- Returns:
- The originKey.
-
setOriginKey
public StardocOutputProtos.StarlarkFunctionInfo.Builder setOriginKey(StardocOutputProtos.OriginKey value) The module where and the name under which the function was originally declared. Note: legacy Stardoc (0.5.x and earlier) does not set this field.
.stardoc_output.OriginKey origin_key = 6; -
setOriginKey
public StardocOutputProtos.StarlarkFunctionInfo.Builder setOriginKey(StardocOutputProtos.OriginKey.Builder builderForValue) The module where and the name under which the function was originally declared. Note: legacy Stardoc (0.5.x and earlier) does not set this field.
.stardoc_output.OriginKey origin_key = 6; -
mergeOriginKey
public StardocOutputProtos.StarlarkFunctionInfo.Builder mergeOriginKey(StardocOutputProtos.OriginKey value) The module where and the name under which the function was originally declared. Note: legacy Stardoc (0.5.x and earlier) does not set this field.
.stardoc_output.OriginKey origin_key = 6; -
clearOriginKey
The module where and the name under which the function was originally declared. Note: legacy Stardoc (0.5.x and earlier) does not set this field.
.stardoc_output.OriginKey origin_key = 6; -
getOriginKeyBuilder
The module where and the name under which the function was originally declared. Note: legacy Stardoc (0.5.x and earlier) does not set this field.
.stardoc_output.OriginKey origin_key = 6; -
getOriginKeyOrBuilder
The module where and the name under which the function was originally declared. Note: legacy Stardoc (0.5.x and earlier) does not set this field.
.stardoc_output.OriginKey origin_key = 6;- Specified by:
getOriginKeyOrBuilderin interfaceStardocOutputProtos.StarlarkFunctionInfoOrBuilder
-