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

Class StardocOutputProtos.AttributeInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.devtools.build.lib.starlarkdocextract.StardocOutputProtos.AttributeInfo
All Implemented Interfaces:
StardocOutputProtos.AttributeInfoOrBuilder, 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.AttributeInfo extends com.google.protobuf.GeneratedMessage implements StardocOutputProtos.AttributeInfoOrBuilder
 Representation of a Starlark rule, repository rule, or module extension tag
 attribute definition, comprised of an attribute name, and a schema defined by
 a call to one of the 'attr' module methods enumerated at
 https://bazel.build/rules/lib/attr
Protobuf type stardoc_output.AttributeInfo
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DOC_STRING_FIELD_NUMBER

      public static final int DOC_STRING_FIELD_NUMBER
      See Also:

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • MANDATORY_FIELD_NUMBER

      public static final int MANDATORY_FIELD_NUMBER
      See Also:

    • PROVIDER_NAME_GROUP_FIELD_NUMBER

      public static final int PROVIDER_NAME_GROUP_FIELD_NUMBER
      See Also:

    • DEFAULT_VALUE_FIELD_NUMBER

      public static final int DEFAULT_VALUE_FIELD_NUMBER
      See Also:

    • NONCONFIGURABLE_FIELD_NUMBER

      public static final int NONCONFIGURABLE_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

    • getName

      public String getName()
       The name of the attribute.
      string name = 1;
      Specified by:
      getName in interface StardocOutputProtos.AttributeInfoOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name of the attribute.
      string name = 1;
      Specified by:
      getNameBytes in interface StardocOutputProtos.AttributeInfoOrBuilder
      Returns:
      The bytes for name.

    • getDocString

      public String getDocString()
       The documentation string of the attribute, supplied via the 'doc'
 parameter to the schema-creation call.
      string doc_string = 2;
      Specified by:
      getDocString in interface StardocOutputProtos.AttributeInfoOrBuilder
      Returns:
      The docString.

    • getDocStringBytes

      public com.google.protobuf.ByteString getDocStringBytes()
       The documentation string of the attribute, supplied via the 'doc'
 parameter to the schema-creation call.
      string doc_string = 2;
      Specified by:
      getDocStringBytes in interface StardocOutputProtos.AttributeInfoOrBuilder
      Returns:
      The bytes for docString.

    • getTypeValue

      public int getTypeValue()
       The type of the attribute, defined generally by which function is invoked
 in the attr module.
      .stardoc_output.AttributeType type = 3;
      Specified by:
      getTypeValue in interface StardocOutputProtos.AttributeInfoOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public StardocOutputProtos.AttributeType getType()
       The type of the attribute, defined generally by which function is invoked
 in the attr module.
      .stardoc_output.AttributeType type = 3;
      Specified by:
      getType in interface StardocOutputProtos.AttributeInfoOrBuilder
      Returns:
      The type.

    • getMandatory

      public boolean getMandatory()
       If true, all targets of the rule must specify a value for this attribute.
      bool mandatory = 4;
      Specified by:
      getMandatory in interface StardocOutputProtos.AttributeInfoOrBuilder
      Returns:
      The mandatory.

    • getProviderNameGroupList

      public List<StardocOutputProtos.ProviderNameGroup> getProviderNameGroupList()
       The target(s) in this attribute must define all the providers of at least
 one of the ProviderNameGroups in this list. If the Attribute Type is not a
 label, a label list, or a label-keyed string dictionary, the field will be
 left empty. For attributes of a repository rule or a module extension tag,
 this attribute is meaningless and may be ignored.
 TODO(b/290788853): ensure this field is always empty for attributes of a
 repository rule or a module extension tag.
      repeated .stardoc_output.ProviderNameGroup provider_name_group = 5;
      Specified by:
      getProviderNameGroupList in interface StardocOutputProtos.AttributeInfoOrBuilder

    • getProviderNameGroupOrBuilderList

      public List<? extends StardocOutputProtos.ProviderNameGroupOrBuilder> getProviderNameGroupOrBuilderList()
       The target(s) in this attribute must define all the providers of at least
 one of the ProviderNameGroups in this list. If the Attribute Type is not a
 label, a label list, or a label-keyed string dictionary, the field will be
 left empty. For attributes of a repository rule or a module extension tag,
 this attribute is meaningless and may be ignored.
 TODO(b/290788853): ensure this field is always empty for attributes of a
 repository rule or a module extension tag.
      repeated .stardoc_output.ProviderNameGroup provider_name_group = 5;
      Specified by:
      getProviderNameGroupOrBuilderList in interface StardocOutputProtos.AttributeInfoOrBuilder

    • getProviderNameGroupCount

      public int getProviderNameGroupCount()
       The target(s) in this attribute must define all the providers of at least
 one of the ProviderNameGroups in this list. If the Attribute Type is not a
 label, a label list, or a label-keyed string dictionary, the field will be
 left empty. For attributes of a repository rule or a module extension tag,
 this attribute is meaningless and may be ignored.
 TODO(b/290788853): ensure this field is always empty for attributes of a
 repository rule or a module extension tag.
      repeated .stardoc_output.ProviderNameGroup provider_name_group = 5;
      Specified by:
      getProviderNameGroupCount in interface StardocOutputProtos.AttributeInfoOrBuilder

    • getProviderNameGroup

      public StardocOutputProtos.ProviderNameGroup getProviderNameGroup(int index)
       The target(s) in this attribute must define all the providers of at least
 one of the ProviderNameGroups in this list. If the Attribute Type is not a
 label, a label list, or a label-keyed string dictionary, the field will be
 left empty. For attributes of a repository rule or a module extension tag,
 this attribute is meaningless and may be ignored.
 TODO(b/290788853): ensure this field is always empty for attributes of a
 repository rule or a module extension tag.
      repeated .stardoc_output.ProviderNameGroup provider_name_group = 5;
      Specified by:
      getProviderNameGroup in interface StardocOutputProtos.AttributeInfoOrBuilder

    • getProviderNameGroupOrBuilder

      public StardocOutputProtos.ProviderNameGroupOrBuilder getProviderNameGroupOrBuilder(int index)
       The target(s) in this attribute must define all the providers of at least
 one of the ProviderNameGroups in this list. If the Attribute Type is not a
 label, a label list, or a label-keyed string dictionary, the field will be
 left empty. For attributes of a repository rule or a module extension tag,
 this attribute is meaningless and may be ignored.
 TODO(b/290788853): ensure this field is always empty for attributes of a
 repository rule or a module extension tag.
      repeated .stardoc_output.ProviderNameGroup provider_name_group = 5;
      Specified by:
      getProviderNameGroupOrBuilder in interface StardocOutputProtos.AttributeInfoOrBuilder

    • getDefaultValue

      public String getDefaultValue()
       The string representation of the default value of this attribute.
      string default_value = 6;
      Specified by:
      getDefaultValue in interface StardocOutputProtos.AttributeInfoOrBuilder
      Returns:
      The defaultValue.

    • getDefaultValueBytes

      public com.google.protobuf.ByteString getDefaultValueBytes()
       The string representation of the default value of this attribute.
      string default_value = 6;
      Specified by:
      getDefaultValueBytes in interface StardocOutputProtos.AttributeInfoOrBuilder
      Returns:
      The bytes for defaultValue.

    • getNonconfigurable

      public boolean getNonconfigurable()
       If true, the attribute is non-configurable.
      bool nonconfigurable = 7;
      Specified by:
      getNonconfigurable in interface StardocOutputProtos.AttributeInfoOrBuilder
      Returns:
      The nonconfigurable.

    • 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.AttributeInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StardocOutputProtos.AttributeInfo.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static StardocOutputProtos.AttributeInfo getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<StardocOutputProtos.AttributeInfo> 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.AttributeInfo getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder