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

Interface StardocOutputProtos.RuleInfoOrBuilder

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

  • Method Details

    • getRuleName

      String getRuleName()
       In Stardoc and starlark_doc_extract output, this is the name under which
 the rule is made accessible to a user of this module, including any structs
 it is nested in, for example "foo.foo_library".

 In query output, this is the name under which the rule was defined (which
 might be a private symbol prefixed with "_").
      string rule_name = 1;
      Returns:
      The ruleName.

    • getRuleNameBytes

      com.google.protobuf.ByteString getRuleNameBytes()
       In Stardoc and starlark_doc_extract output, this is the name under which
 the rule is made accessible to a user of this module, including any structs
 it is nested in, for example "foo.foo_library".

 In query output, this is the name under which the rule was defined (which
 might be a private symbol prefixed with "_").
      string rule_name = 1;
      Returns:
      The bytes for ruleName.

    • getDocString

      String getDocString()
       The documentation string of the rule.
      string doc_string = 2;
      Returns:
      The docString.

    • getDocStringBytes

      com.google.protobuf.ByteString getDocStringBytes()
       The documentation string of the rule.
      string doc_string = 2;
      Returns:
      The bytes for docString.

    • getAttributeList

      List<StardocOutputProtos.AttributeInfo> getAttributeList()
       The attributes of the rule.
      repeated .stardoc_output.AttributeInfo attribute = 3;

    • getAttribute

      StardocOutputProtos.AttributeInfo getAttribute(int index)
       The attributes of the rule.
      repeated .stardoc_output.AttributeInfo attribute = 3;

    • getAttributeCount

      int getAttributeCount()
       The attributes of the rule.
      repeated .stardoc_output.AttributeInfo attribute = 3;

    • getAttributeOrBuilderList

      List<? extends StardocOutputProtos.AttributeInfoOrBuilder> getAttributeOrBuilderList()
       The attributes of the rule.
      repeated .stardoc_output.AttributeInfo attribute = 3;

    • getAttributeOrBuilder

      StardocOutputProtos.AttributeInfoOrBuilder getAttributeOrBuilder(int index)
       The attributes of the rule.
      repeated .stardoc_output.AttributeInfo attribute = 3;

    • hasOriginKey

      boolean hasOriginKey()
       The module where and the name under which the rule was originally declared.
      .stardoc_output.OriginKey origin_key = 4;
      Returns:
      Whether the originKey field is set.

    • getOriginKey

      StardocOutputProtos.OriginKey getOriginKey()
       The module where and the name under which the rule was originally declared.
      .stardoc_output.OriginKey origin_key = 4;
      Returns:
      The originKey.

    • getOriginKeyOrBuilder

      StardocOutputProtos.OriginKeyOrBuilder getOriginKeyOrBuilder()
       The module where and the name under which the rule was originally declared.
      .stardoc_output.OriginKey origin_key = 4;

    • hasAdvertisedProviders

      boolean hasAdvertisedProviders()
       The list of providers that the rule's implementation must return. Unset if
 the rule lists no advertised providers.
      .stardoc_output.ProviderNameGroup advertised_providers = 5;
      Returns:
      Whether the advertisedProviders field is set.

    • getAdvertisedProviders

      StardocOutputProtos.ProviderNameGroup getAdvertisedProviders()
       The list of providers that the rule's implementation must return. Unset if
 the rule lists no advertised providers.
      .stardoc_output.ProviderNameGroup advertised_providers = 5;
      Returns:
      The advertisedProviders.

    • getAdvertisedProvidersOrBuilder

      StardocOutputProtos.ProviderNameGroupOrBuilder getAdvertisedProvidersOrBuilder()
       The list of providers that the rule's implementation must return. Unset if
 the rule lists no advertised providers.
      .stardoc_output.ProviderNameGroup advertised_providers = 5;

    • getTest

      boolean getTest()
       True if this is a test rule.
      bool test = 6;
      Returns:
      The test.

    • getExecutable

      boolean getExecutable()
       True if this is an executable rule.

 Note: if test is true, executable is also true (test rules are implicitly
 executable).
      bool executable = 7;
      Returns:
      The executable.