Top Description Fields Constructors Methods
com.vladsch.flexmark.ext.macros

public Class MacroDefinitionBlock

extends Block
implements ReferenceNode<MacroDefinitionRepository, MacroDefinitionBlock, MacroReference>
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.ast.ReferenceNode, java.lang.Comparable
Imports
com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository, com.vladsch.flexmark.util.ast.Block, .BlockContent, .Node, .ReferenceNode, com.vladsch.flexmark.util.sequence.BasedSequence, .SequenceUtils, org.jetbrains.annotations.NotNull, .Nullable, java.util.List
A MacroReference block node

Field Summary

Modifier and TypeField and Description
private BasedSequence
closingMarker

private BasedSequence
closingTrailing

private int
firstReferenceOffset

private int
footnoteReferences

private boolean
inExpansion

private BasedSequence
name

private BasedSequence
openingMarker

private BasedSequence
openingTrailing

private int
ordinal

Constructor Summary

AccessConstructor and Description
public
MacroDefinitionBlock()

public
MacroDefinitionBlock(BasedSequence chars)

public
MacroDefinitionBlock(BasedSequence chars, List<BasedSequence> segments)

public
MacroDefinitionBlock(BlockContent blockContent)

Method Summary

Modifier and TypeMethod and Description
public void
addFirstReferenceOffset(int firstReferenceOffset)

public int
compareTo(MacroDefinitionBlock
the object to be compared.
other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public void
getAstExtra(@NotNull StringBuilder out)

public BasedSequence
getClosingMarker()

public BasedSequence
getClosingTrailing()

public int
getFirstReferenceOffset()

public int
getFootnoteReferences()

public BasedSequence
getName()

public BasedSequence
getOpeningMarker()

public BasedSequence
getOpeningTrailing()

public int
getOrdinal()

public @Nullable MacroReference
getReferencingNode(@NotNull Node node)

public @NotNull BasedSequence[]
getSegments()

Implements abstract com.vladsch.flexmark.util.ast.Node.getSegments.

public boolean
isInExpansion()

public boolean
isReferenced()

public void
setClosingMarker(BasedSequence closingMarker)

public void
setClosingTrailing(BasedSequence closingTrailing)

public void
setFirstReferenceOffset(int firstReferenceOffset)

public void
setFootnoteReferences(int footnoteReferences)

public void
setInExpansion(boolean inExpansion)

public void
setName(BasedSequence name)

public void
setOpeningMarker(BasedSequence openingMarker)

public void
setOpeningTrailing(BasedSequence openingTrailing)

public void
setOrdinal(int ordinal)

Inherited from com.vladsch.flexmark.util.ast.Block:
getParentsetParent

Field Detail

closingMarkerback to summary
private BasedSequence closingMarker
closingTrailingback to summary
private BasedSequence closingTrailing
firstReferenceOffsetback to summary
private int firstReferenceOffset
footnoteReferencesback to summary
private int footnoteReferences
inExpansionback to summary
private boolean inExpansion
nameback to summary
private BasedSequence name
openingMarkerback to summary
private BasedSequence openingMarker
openingTrailingback to summary
private BasedSequence openingTrailing
ordinalback to summary
private int ordinal

Constructor Detail

MacroDefinitionBlockback to summary
public MacroDefinitionBlock()
MacroDefinitionBlockback to summary
public MacroDefinitionBlock(BasedSequence chars)
MacroDefinitionBlockback to summary
public MacroDefinitionBlock(BasedSequence chars, List<BasedSequence> segments)
MacroDefinitionBlockback to summary
public MacroDefinitionBlock(BlockContent blockContent)

Method Detail

addFirstReferenceOffsetback to summary
public void addFirstReferenceOffset(int firstReferenceOffset)
compareToback to summary
public int compareTo(MacroDefinitionBlock other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:MacroDefinitionBlock

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
getAstExtraback to summary
public void getAstExtra(@NotNull StringBuilder out)
Annotations
@Override
getClosingMarkerback to summary
public BasedSequence getClosingMarker()
getClosingTrailingback to summary
public BasedSequence getClosingTrailing()
getFirstReferenceOffsetback to summary
public int getFirstReferenceOffset()
getFootnoteReferencesback to summary
public int getFootnoteReferences()
getNameback to summary
public BasedSequence getName()
getOpeningMarkerback to summary
public BasedSequence getOpeningMarker()
getOpeningTrailingback to summary
public BasedSequence getOpeningTrailing()
getOrdinalback to summary
public int getOrdinal()
getReferencingNodeback to summary
public @Nullable MacroReference getReferencingNode(@NotNull Node node)
Annotations
@Nullable
@Override
getSegmentsback to summary
public @NotNull BasedSequence[] getSegments()

Implements abstract com.vladsch.flexmark.util.ast.Node.getSegments.

Annotations
@NotNull
@Override
isInExpansionback to summary
public boolean isInExpansion()
isReferencedback to summary
public boolean isReferenced()
setClosingMarkerback to summary
public void setClosingMarker(BasedSequence closingMarker)
setClosingTrailingback to summary
public void setClosingTrailing(BasedSequence closingTrailing)
setFirstReferenceOffsetback to summary
public void setFirstReferenceOffset(int firstReferenceOffset)
setFootnoteReferencesback to summary
public void setFootnoteReferences(int footnoteReferences)
setInExpansionback to summary
public void setInExpansion(boolean inExpansion)
setNameback to summary
public void setName(BasedSequence name)
setOpeningMarkerback to summary
public void setOpeningMarker(BasedSequence openingMarker)
setOpeningTrailingback to summary
public void setOpeningTrailing(BasedSequence openingTrailing)
setOrdinalback to summary
public void setOrdinal(int ordinal)