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

public Class AbbreviationBlock

extends Block
implements ReferenceNode<AbbreviationRepository, AbbreviationBlock, Abbreviation>
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.ast.ReferenceNode, java.lang.Comparable
Imports
com.vladsch.flexmark.ext.abbreviation.internal.AbbreviationRepository, com.vladsch.flexmark.util.ast.Block, .Node, .ReferenceNode, com.vladsch.flexmark.util.sequence.BasedSequence, .SequenceUtils, org.jetbrains.annotations.NotNull, .Nullable
A block node that contains the abbreviation definition

Field Summary

Modifier and TypeField and Description
protected BasedSequence
abbreviation

protected BasedSequence
closingMarker

protected BasedSequence
openingMarker

protected BasedSequence
text

Constructor Summary

AccessConstructor and Description
public
AbbreviationBlock()

public
AbbreviationBlock(BasedSequence chars)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(AbbreviationBlock
the object to be compared.
other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public BasedSequence
getAbbreviation()

public void
getAstExtra(@NotNull StringBuilder out)

public BasedSequence
getClosingMarker()

public BasedSequence
getOpeningMarker()

public @Nullable Abbreviation
getReferencingNode(@NotNull Node node)

public @NotNull BasedSequence[]
getSegments()

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

public BasedSequence
getText()

public void
setAbbreviation(BasedSequence abbreviation)

public void
setClosingMarker(BasedSequence closingMarker)

public void
setOpeningMarker(BasedSequence openingMarker)

public void
setText(BasedSequence text)

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

Field Detail

abbreviationback to summary
protected BasedSequence abbreviation
closingMarkerback to summary
protected BasedSequence closingMarker
openingMarkerback to summary
protected BasedSequence openingMarker
textback to summary
protected BasedSequence text

Constructor Detail

AbbreviationBlockback to summary
public AbbreviationBlock()
AbbreviationBlockback to summary
public AbbreviationBlock(BasedSequence chars)

Method Detail

compareToback to summary
public int compareTo(AbbreviationBlock 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:AbbreviationBlock

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
getAbbreviationback to summary
public BasedSequence getAbbreviation()
getAstExtraback to summary
public void getAstExtra(@NotNull StringBuilder out)
Annotations
@Override
getClosingMarkerback to summary
public BasedSequence getClosingMarker()
getOpeningMarkerback to summary
public BasedSequence getOpeningMarker()
getReferencingNodeback to summary
public @Nullable Abbreviation 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
getTextback to summary
public BasedSequence getText()
setAbbreviationback to summary
public void setAbbreviation(BasedSequence abbreviation)
setClosingMarkerback to summary
public void setClosingMarker(BasedSequence closingMarker)
setOpeningMarkerback to summary
public void setOpeningMarker(BasedSequence openingMarker)
setTextback to summary
public void setText(BasedSequence text)