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

Interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StardocOutputProtos.StarlarkFunctionInfo, StardocOutputProtos.StarlarkFunctionInfo.Builder
Enclosing class:
StardocOutputProtos
public static interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    StardocOutputProtos.FunctionDeprecationInfo
    getDeprecated()
    The deprecation for the function.
    StardocOutputProtos.FunctionDeprecationInfoOrBuilder
    getDeprecatedOrBuilder()
    The deprecation for the function.
    String
    getDocString()
    The documented description of the function (if specified in the function's docstring).
    com.google.protobuf.ByteString
    getDocStringBytes()
    The documented description of the function (if specified in the function's docstring).
    String
    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".
    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".
    StardocOutputProtos.OriginKey
    getOriginKey()
    The module where and the name under which the function was originally declared.
    StardocOutputProtos.OriginKeyOrBuilder
    getOriginKeyOrBuilder()
    The module where and the name under which the function was originally declared.
    StardocOutputProtos.FunctionParamInfo
    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`).
    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`).
    List<StardocOutputProtos.FunctionParamInfo>
    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`).
    StardocOutputProtos.FunctionParamInfoOrBuilder
    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`).
    List<? extends StardocOutputProtos.FunctionParamInfoOrBuilder>
    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`).
    StardocOutputProtos.FunctionReturnInfo
    getReturn()
    The return value for the function.
    StardocOutputProtos.FunctionReturnInfoOrBuilder
    getReturnOrBuilder()
    The return value for the function.
    boolean
    hasDeprecated()
    The deprecation for the function.
    boolean
    hasOriginKey()
    The module where and the name under which the function was originally declared.
    boolean
    hasReturn()
    The return value for the function.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getFunctionName

      String 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;
      Returns:
      The functionName.

    • getFunctionNameBytes

      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;
      Returns:
      The bytes for functionName.

    • getParameterList

      List<StardocOutputProtos.FunctionParamInfo> 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;

    • getParameter

      StardocOutputProtos.FunctionParamInfo 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`). The declaration order
 can be recovered by looking for the transition from ordinary/positional to
 keyword-only.
      repeated .stardoc_output.FunctionParamInfo parameter = 2;

    • getParameterCount

      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;

    • getParameterOrBuilderList

      List<? extends StardocOutputProtos.FunctionParamInfoOrBuilder> 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;

    • getParameterOrBuilder

      StardocOutputProtos.FunctionParamInfoOrBuilder 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 declaration order
 can be recovered by looking for the transition from ordinary/positional to
 keyword-only.
      repeated .stardoc_output.FunctionParamInfo parameter = 2;

    • getDocString

      String getDocString()
       The documented description of the function (if specified in the function's
 docstring).
      string doc_string = 3;
      Returns:
      The docString.

    • getDocStringBytes

      com.google.protobuf.ByteString getDocStringBytes()
       The documented description of the function (if specified in the function's
 docstring).
      string doc_string = 3;
      Returns:
      The bytes for docString.

    • hasReturn

      boolean hasReturn()
       The return value for the function.
      .stardoc_output.FunctionReturnInfo return = 4;
      Returns:
      Whether the return field is set.

    • getReturn

      StardocOutputProtos.FunctionReturnInfo getReturn()
       The return value for the function.
      .stardoc_output.FunctionReturnInfo return = 4;
      Returns:
      The return.

    • getReturnOrBuilder

      StardocOutputProtos.FunctionReturnInfoOrBuilder getReturnOrBuilder()
       The return value for the function.
      .stardoc_output.FunctionReturnInfo return = 4;

    • hasDeprecated

      boolean hasDeprecated()
       The deprecation for the function.
      .stardoc_output.FunctionDeprecationInfo deprecated = 5;
      Returns:
      Whether the deprecated field is set.

    • getDeprecated

      StardocOutputProtos.FunctionDeprecationInfo getDeprecated()
       The deprecation for the function.
      .stardoc_output.FunctionDeprecationInfo deprecated = 5;
      Returns:
      The deprecated.

    • getDeprecatedOrBuilder

      StardocOutputProtos.FunctionDeprecationInfoOrBuilder getDeprecatedOrBuilder()
       The deprecation for the function.
      .stardoc_output.FunctionDeprecationInfo deprecated = 5;

    • hasOriginKey

      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;
      Returns:
      Whether the originKey field is set.

    • getOriginKey

      StardocOutputProtos.OriginKey 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;
      Returns:
      The originKey.

    • getOriginKeyOrBuilder

      StardocOutputProtos.OriginKeyOrBuilder 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;