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

Class StardocOutputProtos.RuleInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.devtools.build.lib.starlarkdocextract.StardocOutputProtos.RuleInfo
All Implemented Interfaces:
StardocOutputProtos.RuleInfoOrBuilder, 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.RuleInfo extends com.google.protobuf.GeneratedMessage implements StardocOutputProtos.RuleInfoOrBuilder
 Representation of a Starlark rule definition.
Protobuf type stardoc_output.RuleInfo
See Also:

  • Field Details

    • RULE_NAME_FIELD_NUMBER

      public static final int RULE_NAME_FIELD_NUMBER
      See Also:

    • DOC_STRING_FIELD_NUMBER

      public static final int DOC_STRING_FIELD_NUMBER
      See Also:

    • ATTRIBUTE_FIELD_NUMBER

      public static final int ATTRIBUTE_FIELD_NUMBER
      See Also:

    • ORIGIN_KEY_FIELD_NUMBER

      public static final int ORIGIN_KEY_FIELD_NUMBER
      See Also:

    • ADVERTISED_PROVIDERS_FIELD_NUMBER

      public static final int ADVERTISED_PROVIDERS_FIELD_NUMBER
      See Also:

    • TEST_FIELD_NUMBER

      public static final int TEST_FIELD_NUMBER
      See Also:

    • EXECUTABLE_FIELD_NUMBER

      public static final int EXECUTABLE_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:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getRuleName

      public 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;
      Specified by:
      getRuleName in interface StardocOutputProtos.RuleInfoOrBuilder
      Returns:
      The ruleName.

    • getRuleNameBytes

      public 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;
      Specified by:
      getRuleNameBytes in interface StardocOutputProtos.RuleInfoOrBuilder
      Returns:
      The bytes for ruleName.

    • getDocString

      public String getDocString()
       The documentation string of the rule.
      string doc_string = 2;
      Specified by:
      getDocString in interface StardocOutputProtos.RuleInfoOrBuilder
      Returns:
      The docString.

    • getDocStringBytes

      public com.google.protobuf.ByteString getDocStringBytes()
       The documentation string of the rule.
      string doc_string = 2;
      Specified by:
      getDocStringBytes in interface StardocOutputProtos.RuleInfoOrBuilder
      Returns:
      The bytes for docString.

    • getAttributeList

      public List<StardocOutputProtos.AttributeInfo> getAttributeList()
       The attributes of the rule.
      repeated .stardoc_output.AttributeInfo attribute = 3;
      Specified by:
      getAttributeList in interface StardocOutputProtos.RuleInfoOrBuilder

    • getAttributeOrBuilderList

      public List<? extends StardocOutputProtos.AttributeInfoOrBuilder> getAttributeOrBuilderList()
       The attributes of the rule.
      repeated .stardoc_output.AttributeInfo attribute = 3;
      Specified by:
      getAttributeOrBuilderList in interface StardocOutputProtos.RuleInfoOrBuilder

    • getAttributeCount

      public int getAttributeCount()
       The attributes of the rule.
      repeated .stardoc_output.AttributeInfo attribute = 3;
      Specified by:
      getAttributeCount in interface StardocOutputProtos.RuleInfoOrBuilder

    • getAttribute

      public StardocOutputProtos.AttributeInfo getAttribute(int index)
       The attributes of the rule.
      repeated .stardoc_output.AttributeInfo attribute = 3;
      Specified by:
      getAttribute in interface StardocOutputProtos.RuleInfoOrBuilder

    • getAttributeOrBuilder

      public StardocOutputProtos.AttributeInfoOrBuilder getAttributeOrBuilder(int index)
       The attributes of the rule.
      repeated .stardoc_output.AttributeInfo attribute = 3;
      Specified by:
      getAttributeOrBuilder in interface StardocOutputProtos.RuleInfoOrBuilder

    • hasOriginKey

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

    • getOriginKey

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

    • getOriginKeyOrBuilder

      public StardocOutputProtos.OriginKeyOrBuilder getOriginKeyOrBuilder()
       The module where and the name under which the rule was originally declared.
      .stardoc_output.OriginKey origin_key = 4;
      Specified by:
      getOriginKeyOrBuilder in interface StardocOutputProtos.RuleInfoOrBuilder

    • hasAdvertisedProviders

      public 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;
      Specified by:
      hasAdvertisedProviders in interface StardocOutputProtos.RuleInfoOrBuilder
      Returns:
      Whether the advertisedProviders field is set.

    • getAdvertisedProviders

      public 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;
      Specified by:
      getAdvertisedProviders in interface StardocOutputProtos.RuleInfoOrBuilder
      Returns:
      The advertisedProviders.

    • getAdvertisedProvidersOrBuilder

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

    • getTest

      public boolean getTest()
       True if this is a test rule.
      bool test = 6;
      Specified by:
      getTest in interface StardocOutputProtos.RuleInfoOrBuilder
      Returns:
      The test.

    • getExecutable

      public 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;
      Specified by:
      getExecutable in interface StardocOutputProtos.RuleInfoOrBuilder
      Returns:
      The executable.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static StardocOutputProtos.RuleInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StardocOutputProtos.RuleInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StardocOutputProtos.RuleInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StardocOutputProtos.RuleInfo 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.RuleInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StardocOutputProtos.RuleInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StardocOutputProtos.RuleInfo parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StardocOutputProtos.RuleInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StardocOutputProtos.RuleInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StardocOutputProtos.RuleInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StardocOutputProtos.RuleInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StardocOutputProtos.RuleInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public StardocOutputProtos.RuleInfo.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static StardocOutputProtos.RuleInfo.Builder newBuilder()

    • newBuilder

      public static StardocOutputProtos.RuleInfo.Builder newBuilder(StardocOutputProtos.RuleInfo prototype)

    • toBuilder

      public StardocOutputProtos.RuleInfo.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected StardocOutputProtos.RuleInfo.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static StardocOutputProtos.RuleInfo getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StardocOutputProtos.RuleInfo> parser()

    • getParserForType

      public com.google.protobuf.Parser<StardocOutputProtos.RuleInfo> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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