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

Class StardocOutputProtos.MacroInfo

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.devtools.build.lib.starlarkdocextract.StardocOutputProtos.MacroInfo

All Implemented Interfaces:

StardocOutputProtos.MacroInfoOrBuilder, 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.MacroInfo
extends com.google.protobuf.GeneratedMessage
implements StardocOutputProtos.MacroInfoOrBuilder

 Representation of a Starlark symbolic macro definition.
 Note: symbolic macros (and thus, their documentation format) are an
 experimental feature gated by the --experimental_enable_first_class_macros
 flag.
 

Protobuf type stardoc_output.MacroInfo

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StardocOutputProtos.MacroInfo.Builder	Representation of a Starlark symbolic macro definition.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ATTRIBUTE_FIELD_NUMBER
static final int	DOC_STRING_FIELD_NUMBER
static final int	MACRO_NAME_FIELD_NUMBER
static final int	ORIGIN_KEY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
StardocOutputProtos.AttributeInfo	getAttribute(int index)	The attributes of the macro.
int	getAttributeCount()	The attributes of the macro.
List<StardocOutputProtos.AttributeInfo>	getAttributeList()	The attributes of the macro.
StardocOutputProtos.AttributeInfoOrBuilder	getAttributeOrBuilder(int index)	The attributes of the macro.
List<? extends StardocOutputProtos.AttributeInfoOrBuilder>	getAttributeOrBuilderList()	The attributes of the macro.
static StardocOutputProtos.MacroInfo	getDefaultInstance()
StardocOutputProtos.MacroInfo	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDocString()	The documentation string of the macro.
com.google.protobuf.ByteString	getDocStringBytes()	The documentation string of the macro.
String	getMacroName()	The name under which the macro is made accessible to a user of this module, including any structs it is nested in, for example "foo.foo_library".
com.google.protobuf.ByteString	getMacroNameBytes()	The name under which the macro is made accessible to a user of this module, including any structs it is nested in, for example "foo.foo_library".
StardocOutputProtos.OriginKey	getOriginKey()	The module where and the name under which the macro was originally declared.
StardocOutputProtos.OriginKeyOrBuilder	getOriginKeyOrBuilder()	The module where and the name under which the macro was originally declared.
com.google.protobuf.Parser<StardocOutputProtos.MacroInfo>	getParserForType()
int	getSerializedSize()
int	hashCode()
boolean	hasOriginKey()	The module where and the name under which the macro was originally declared.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static StardocOutputProtos.MacroInfo.Builder	newBuilder()
static StardocOutputProtos.MacroInfo.Builder	newBuilder(StardocOutputProtos.MacroInfo prototype)
StardocOutputProtos.MacroInfo.Builder	newBuilderForType()
protected StardocOutputProtos.MacroInfo.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static StardocOutputProtos.MacroInfo	parseDelimitedFrom(InputStream input)
static StardocOutputProtos.MacroInfo	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StardocOutputProtos.MacroInfo	parseFrom(byte[] data)
static StardocOutputProtos.MacroInfo	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StardocOutputProtos.MacroInfo	parseFrom(com.google.protobuf.ByteString data)
static StardocOutputProtos.MacroInfo	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StardocOutputProtos.MacroInfo	parseFrom(com.google.protobuf.CodedInputStream input)
static StardocOutputProtos.MacroInfo	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StardocOutputProtos.MacroInfo	parseFrom(InputStream input)
static StardocOutputProtos.MacroInfo	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StardocOutputProtos.MacroInfo	parseFrom(ByteBuffer data)
static StardocOutputProtos.MacroInfo	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StardocOutputProtos.MacroInfo>	parser()
StardocOutputProtos.MacroInfo.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

MACRO_NAME_FIELD_NUMBER

public static final int MACRO_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

DOC_STRING_FIELD_NUMBER

public static final int DOC_STRING_FIELD_NUMBER

See Also:

• Constant Field Values

ATTRIBUTE_FIELD_NUMBER

public static final int ATTRIBUTE_FIELD_NUMBER

See Also:

• Constant Field Values

ORIGIN_KEY_FIELD_NUMBER

public static final int ORIGIN_KEY_FIELD_NUMBER

See Also:

• Constant Field Values

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

getMacroName

public String getMacroName()

 The name under which the macro is made accessible to a user of this module,
 including any structs it is nested in, for example "foo.foo_library".
 

string macro_name = 1;

Specified by:

getMacroName in interface StardocOutputProtos.MacroInfoOrBuilder

Returns:

The macroName.

getMacroNameBytes

public com.google.protobuf.ByteString getMacroNameBytes()

 The name under which the macro is made accessible to a user of this module,
 including any structs it is nested in, for example "foo.foo_library".
 

string macro_name = 1;

Specified by:

getMacroNameBytes in interface StardocOutputProtos.MacroInfoOrBuilder

Returns:

The bytes for macroName.

getDocString

public String getDocString()

 The documentation string of the macro.
 

string doc_string = 2;

Specified by:

getDocString in interface StardocOutputProtos.MacroInfoOrBuilder

Returns:

The docString.

getDocStringBytes

public com.google.protobuf.ByteString getDocStringBytes()

 The documentation string of the macro.
 

string doc_string = 2;

Specified by:

getDocStringBytes in interface StardocOutputProtos.MacroInfoOrBuilder

Returns:

The bytes for docString.

getAttributeList

public List<StardocOutputProtos.AttributeInfo> getAttributeList()

 The attributes of the macro.
 

repeated .stardoc_output.AttributeInfo attribute = 3;

Specified by:

getAttributeList in interface StardocOutputProtos.MacroInfoOrBuilder

getAttributeOrBuilderList

public List<? extends StardocOutputProtos.AttributeInfoOrBuilder> getAttributeOrBuilderList()

 The attributes of the macro.
 

repeated .stardoc_output.AttributeInfo attribute = 3;

Specified by:

getAttributeOrBuilderList in interface StardocOutputProtos.MacroInfoOrBuilder

getAttributeCount

public int getAttributeCount()

 The attributes of the macro.
 

repeated .stardoc_output.AttributeInfo attribute = 3;

Specified by:

getAttributeCount in interface StardocOutputProtos.MacroInfoOrBuilder

getAttribute

public StardocOutputProtos.AttributeInfo getAttribute(int index)

 The attributes of the macro.
 

repeated .stardoc_output.AttributeInfo attribute = 3;

Specified by:

getAttribute in interface StardocOutputProtos.MacroInfoOrBuilder

getAttributeOrBuilder

public StardocOutputProtos.AttributeInfoOrBuilder getAttributeOrBuilder(int index)

 The attributes of the macro.
 

repeated .stardoc_output.AttributeInfo attribute = 3;

Specified by:

getAttributeOrBuilder in interface StardocOutputProtos.MacroInfoOrBuilder

hasOriginKey

public boolean hasOriginKey()

 The module where and the name under which the macro was originally
 declared.
 

.stardoc_output.OriginKey origin_key = 4;

Specified by:

hasOriginKey in interface StardocOutputProtos.MacroInfoOrBuilder

Returns:

Whether the originKey field is set.

getOriginKey

public StardocOutputProtos.OriginKey getOriginKey()

 The module where and the name under which the macro was originally
 declared.
 

.stardoc_output.OriginKey origin_key = 4;

Specified by:

getOriginKey in interface StardocOutputProtos.MacroInfoOrBuilder

Returns:

The originKey.

getOriginKeyOrBuilder

public StardocOutputProtos.OriginKeyOrBuilder getOriginKeyOrBuilder()

 The module where and the name under which the macro was originally
 declared.
 

.stardoc_output.OriginKey origin_key = 4;

Specified by:

getOriginKeyOrBuilder in interface StardocOutputProtos.MacroInfoOrBuilder

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.MacroInfo parseFrom(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StardocOutputProtos.MacroInfo parseFrom(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StardocOutputProtos.MacroInfo parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static StardocOutputProtos.MacroInfo parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static StardocOutputProtos.MacroInfo parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public StardocOutputProtos.MacroInfo.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StardocOutputProtos.MacroInfo.Builder newBuilder()

newBuilder

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

toBuilder

public StardocOutputProtos.MacroInfo.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected StardocOutputProtos.MacroInfo.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static StardocOutputProtos.MacroInfo getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<StardocOutputProtos.MacroInfo> 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.MacroInfo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder