ANTLR 4.13.1 · org.antlr.v4.runtime.tree.pattern.TagChunk

Represents a placeholder tag in a tree pattern. A tag can have any of the following forms.

expr: An unlabeled placeholder for a parser rule expr.
ID: An unlabeled placeholder for a token of type ID.
e:expr: A labeled placeholder for a parser rule expr.
id:ID: A labeled placeholder for a token of type ID.

This class does not perform any validation on the tag or label names aside from ensuring that the tag is a non-null, non-empty string.

Field Summary

Modifier and Type	Field and Description
private final String	label This is the backing field for `getLabel`.
private final String	tag This is the backing field for `getTag`.

Constructor Summary

Access	Constructor and Description
public	TagChunk(String The tag, which should be the name of a parser rule or token type. tag) Construct a new instance of `TagChunk` using the specified tag and no label.
public	TagChunk(String The label for the tag. If this is `null`, the `TagChunk` represents an unlabeled tag. label, String The tag, which should be the name of a parser rule or token type. tag) Construct a new instance of `TagChunk` using the specified label and tag.

Method Summary

Modifier and Type	Method and Description
public final String	Returns: The label assigned to this chunk, or `null` if no label is assigned to the chunk. getLabel() Get the label, if any, assigned to this chunk.
public final String	Returns: The tag for the chunk. getTag() Get the tag for this chunk.
public String	toString() Overrides java.lang.Object.toString. This method returns a text representation of the tag chunk.

Field Detail

label	back to summary
private final String label This is the backing field for `getLabel`.

tag	back to summary
private final String tag This is the backing field for `getTag`.

Constructor Detail

TagChunk back to summary

TagChunk	back to summary
public TagChunk(String tag) Construct a new instance of `TagChunk` using the specified tag and no label. Parameters tag:String The tag, which should be the name of a parser rule or token type. Exceptions IllegalArgumentException: if `tag` is `null` or empty.

public TagChunk(String tag)

Construct a new instance of TagChunk using the specified tag and no label.

Parameters

tag:String: The tag, which should be the name of a parser rule or token type.

Exceptions

IllegalArgumentException:: if tag is null or empty.

TagChunk back to summary

TagChunk	back to summary
public TagChunk(String label, String tag) Construct a new instance of `TagChunk` using the specified label and tag. Parameters label:String The label for the tag. If this is `null`, the `TagChunk` represents an unlabeled tag. tag:String The tag, which should be the name of a parser rule or token type. Exceptions IllegalArgumentException: if `tag` is `null` or empty.

public TagChunk(String label, String tag)

Construct a new instance of TagChunk using the specified label and tag.

Parameters

label:String: The label for the tag. If this is null, the TagChunk represents an unlabeled tag.
tag:String: The tag, which should be the name of a parser rule or token type.

Exceptions

IllegalArgumentException:: if tag is null or empty.

Method Detail

getLabel back to summary

getLabel	back to summary
public final String getLabel() Get the label, if any, assigned to this chunk. Returns:String The label assigned to this chunk, or `null` if no label is assigned to the chunk.

public final String getLabel()

Get the label, if any, assigned to this chunk.

Returns:String: The label assigned to this chunk, or null if no label is assigned to the chunk.

getTag	back to summary
public final String getTag() Get the tag for this chunk. Returns:String The tag for the chunk.

getTag

back to summary

public final String getTag()

Get the tag for this chunk.

Returns:String: The tag for the chunk.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. This method returns a text representation of the tag chunk. Labeled tags are returned in the form `label:tag`, and unlabeled tags are returned as just the tag name. Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

This method returns a text representation of the tag chunk. Labeled tags are returned in the form label:tag, and unlabeled tags are returned as just the tag name.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override