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 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.Builder<StardocOutputProtos.StarlarkFunctionInfo.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<StardocOutputProtos.StarlarkFunctionInfo.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<StardocOutputProtos.StarlarkFunctionInfo.Builder>
    • getDefaultInstanceForType

      public StardocOutputProtos.StarlarkFunctionInfo getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public StardocOutputProtos.StarlarkFunctionInfo.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StardocOutputProtos.StarlarkFunctionInfo.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.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:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StardocOutputProtos.StarlarkFunctionInfo.Builder>
      Throws:
      IOException
    • getFunctionName

      public 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;
      Specified by:
      getFunctionName in interface StardocOutputProtos.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:
      getFunctionNameBytes in interface StardocOutputProtos.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

      public 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;
      Specified by:
      getParameterList in interface StardocOutputProtos.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:
      getParameterCount in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder
    • getParameter

      public 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;
      Specified by:
      getParameter in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder
    • setParameter

       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

       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

       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

       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

       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

       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

       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

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

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

      public 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;
      Specified by:
      getParameterOrBuilder in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder
    • getParameterOrBuilderList

      public 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;
      Specified by:
      getParameterOrBuilderList in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder
    • addParameterBuilder

      public StardocOutputProtos.FunctionParamInfo.Builder 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

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

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

      public String getDocString()
       The documented description of the function (if specified in the function's
       docstring).
       
      string doc_string = 3;
      Specified by:
      getDocString in interface StardocOutputProtos.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:
      getDocStringBytes in interface StardocOutputProtos.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:
      hasReturn in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder
      Returns:
      Whether the return field is set.
    • getReturn

       The return value for the function.
       
      .stardoc_output.FunctionReturnInfo return = 4;
      Specified by:
      getReturn in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder
      Returns:
      The return.
    • setReturn

       The return value for the function.
       
      .stardoc_output.FunctionReturnInfo return = 4;
    • setReturn

       The return value for the function.
       
      .stardoc_output.FunctionReturnInfo return = 4;
    • mergeReturn

       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:
      getReturnOrBuilder in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder
    • hasDeprecated

      public boolean hasDeprecated()
       The deprecation for the function.
       
      .stardoc_output.FunctionDeprecationInfo deprecated = 5;
      Specified by:
      hasDeprecated in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder
      Returns:
      Whether the deprecated field is set.
    • getDeprecated

       The deprecation for the function.
       
      .stardoc_output.FunctionDeprecationInfo deprecated = 5;
      Specified by:
      getDeprecated in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder
      Returns:
      The deprecated.
    • setDeprecated

       The deprecation for the function.
       
      .stardoc_output.FunctionDeprecationInfo deprecated = 5;
    • setDeprecated

       The deprecation for the function.
       
      .stardoc_output.FunctionDeprecationInfo deprecated = 5;
    • mergeDeprecated

       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:
      getDeprecatedOrBuilder in interface StardocOutputProtos.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:
      hasOriginKey in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder
      Returns:
      Whether the originKey field is set.
    • getOriginKey

      public 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;
      Specified by:
      getOriginKey in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder
      Returns:
      The originKey.
    • setOriginKey

       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

       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

       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

      public StardocOutputProtos.OriginKey.Builder 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

      public 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;
      Specified by:
      getOriginKeyOrBuilder in interface StardocOutputProtos.StarlarkFunctionInfoOrBuilder