Class StardocOutputProtos.StarlarkFunctionInfo
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.devtools.build.lib.starlarkdocextract.StardocOutputProtos.StarlarkFunctionInfo
- All Implemented Interfaces:
StardocOutputProtos.StarlarkFunctionInfoOrBuilder,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.StarlarkFunctionInfo
extends com.google.protobuf.GeneratedMessage
implements StardocOutputProtos.StarlarkFunctionInfoOrBuilder
Representation of Starlark function definition.Protobuf type
stardoc_output.StarlarkFunctionInfo- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classRepresentation of Starlark function 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.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanThe deprecation for the function.The deprecation for the function.static final com.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.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`).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`).com.google.protobuf.Parser<StardocOutputProtos.StarlarkFunctionInfo>The return value for the function.The return value for the function.intbooleanThe deprecation for the function.inthashCode()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 booleannewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<StardocOutputProtos.StarlarkFunctionInfo>parser()voidwriteTo(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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
FUNCTION_NAME_FIELD_NUMBER
public static final int FUNCTION_NAME_FIELD_NUMBER- See Also:
-
PARAMETER_FIELD_NUMBER
public static final int PARAMETER_FIELD_NUMBER- See Also:
-
DOC_STRING_FIELD_NUMBER
public static final int DOC_STRING_FIELD_NUMBER- See Also:
-
RETURN_FIELD_NUMBER
public static final int RETURN_FIELD_NUMBER- See Also:
-
DEPRECATED_FIELD_NUMBER
public static final int DEPRECATED_FIELD_NUMBER- See Also:
-
ORIGIN_KEY_FIELD_NUMBER
public static final int ORIGIN_KEY_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:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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.
-
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
-
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
-
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
-
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
-
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.
-
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.
-
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.
-
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.
-
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
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static StardocOutputProtos.StarlarkFunctionInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static StardocOutputProtos.StarlarkFunctionInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static StardocOutputProtos.StarlarkFunctionInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static StardocOutputProtos.StarlarkFunctionInfo 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.StarlarkFunctionInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static StardocOutputProtos.StarlarkFunctionInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static StardocOutputProtos.StarlarkFunctionInfo parseFrom(InputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static StardocOutputProtos.StarlarkFunctionInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static StardocOutputProtos.StarlarkFunctionInfo parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static StardocOutputProtos.StarlarkFunctionInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static StardocOutputProtos.StarlarkFunctionInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static StardocOutputProtos.StarlarkFunctionInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static StardocOutputProtos.StarlarkFunctionInfo.Builder newBuilder(StardocOutputProtos.StarlarkFunctionInfo prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected StardocOutputProtos.StarlarkFunctionInfo.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-