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

Interface StardocOutputProtos.AttributeInfoOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDefaultValue()
    The string representation of the default value of this attribute.
    com.google.protobuf.ByteString
    getDefaultValueBytes()
    The string representation of the default value of this attribute.
    String
    getDocString()
    The documentation string of the attribute, supplied via the 'doc' parameter to the schema-creation call.
    com.google.protobuf.ByteString
    getDocStringBytes()
    The documentation string of the attribute, supplied via the 'doc' parameter to the schema-creation call.
    boolean
    getMandatory()
    If true, all targets of the rule must specify a value for this attribute.
    String
    getName()
    The name of the attribute.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the attribute.
    boolean
    getNonconfigurable()
    If true, the attribute is non-configurable.
    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.
    int
    getProviderNameGroupCount()
    The target(s) in this attribute must define all the providers of at least one of the ProviderNameGroups in this list.
    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.
    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.
    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.
    StardocOutputProtos.AttributeType
    getType()
    The type of the attribute, defined generally by which function is invoked in the attr module.
    int
    getTypeValue()
    The type of the attribute, defined generally by which function is invoked in the attr module.

    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

    • getName

      String getName()
       The name of the attribute.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the attribute.
      string name = 1;
      Returns:
      The bytes for name.

    • getDocString

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

    • getDocStringBytes

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

    • getTypeValue

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

    • getType

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

    • getMandatory

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

    • getProviderNameGroupList

      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;

    • getProviderNameGroup

      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;

    • getProviderNameGroupCount

      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;

    • getProviderNameGroupOrBuilderList

      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;

    • getProviderNameGroupOrBuilder

      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;

    • getDefaultValue

      String getDefaultValue()
       The string representation of the default value of this attribute.
      string default_value = 6;
      Returns:
      The defaultValue.

    • getDefaultValueBytes

      com.google.protobuf.ByteString getDefaultValueBytes()
       The string representation of the default value of this attribute.
      string default_value = 6;
      Returns:
      The bytes for defaultValue.

    • getNonconfigurable

      boolean getNonconfigurable()
       If true, the attribute is non-configurable.
      bool nonconfigurable = 7;
      Returns:
      The nonconfigurable.