Top Fields Constructors Methods
com.vladsch.flexmark.ast

public Class Reference

extends LinkNodeBase
implements ReferenceNode<ReferenceRepository, Reference, RefNode>
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.ast.ReferenceNode, java.lang.Comparable
Imports
com.vladsch.flexmark.ast.util.ReferenceRepository, com.vladsch.flexmark.util.ast.Node, .ReferenceNode, com.vladsch.flexmark.util.sequence.BasedSequence, .PrefixedSubSequence, .SequenceUtils, org.jetbrains.annotations.NotNull, .Nullable

Field Summary

Modifier and TypeField and Description
protected BasedSequence
closingMarker

protected BasedSequence
openingMarker

protected BasedSequence
reference

Inherited from com.vladsch.flexmark.ast.LinkNodeBase:
anchorMarkeranchorRefpageReftitletitleClosingMarkertitleOpeningMarkerurlurlClosingMarkerurlOpeningMarker

Constructor Summary

AccessConstructor and Description
public
Reference(BasedSequence label, BasedSequence url, BasedSequence title)

Method Summary

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

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public BasedSequence
getAnchorMarker()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getAnchorMarker.

public BasedSequence
getAnchorRef()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getAnchorRef.

public void
getAstExtra(@NotNull StringBuilder out)

public BasedSequence
getClosingMarker()

public BasedSequence
getOpeningMarker()

public BasedSequence
getPageRef()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getPageRef.

public BasedSequence
getReference()

public @Nullable RefNode
getReferencingNode(@NotNull Node node)

public @NotNull BasedSequence[]
getSegments()

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

public @NotNull BasedSequence[]
getSegmentsForChars()

Overrides com.vladsch.flexmark.util.ast.Node.getSegmentsForChars.

Get the segments making up the node's characters.

public BasedSequence
getTitle()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getTitle.

public BasedSequence
getTitleClosingMarker()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getTitleClosingMarker.

public BasedSequence
getTitleOpeningMarker()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getTitleOpeningMarker.

public BasedSequence
getUrl()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getUrl.

public BasedSequence
getUrlClosingMarker()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getUrlClosingMarker.

public BasedSequence
getUrlOpeningMarker()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getUrlOpeningMarker.

public void
setAnchorMarker(BasedSequence anchorMarker)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setAnchorMarker.

public void
setAnchorRef(BasedSequence anchorRef)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setAnchorRef.

public void
setClosingMarker(BasedSequence closingMarker)

public void
setOpeningMarker(BasedSequence openingMarker)

public void
setPageRef(BasedSequence pageRef)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setPageRef.

public void
setReference(BasedSequence reference)

public void
setTitle(BasedSequence title)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setTitle.

public void
setTitleClosingMarker(BasedSequence titleClosingMarker)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setTitleClosingMarker.

public void
setTitleOpeningMarker(BasedSequence titleOpeningMarker)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setTitleOpeningMarker.

public void
setUrl(BasedSequence url)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setUrl.

public void
setUrlClosingMarker(BasedSequence urlClosingMarker)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setUrlClosingMarker.

public void
setUrlOpeningMarker(BasedSequence urlOpeningMarker)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setUrlOpeningMarker.

protected @NotNull String
toStringAttributes()

Overrides com.vladsch.flexmark.util.ast.Node.toStringAttributes.

Inherited from com.vladsch.flexmark.ast.LinkNodeBase:
setTitleCharssetUrlChars

Field Detail

closingMarkerback to summary
protected BasedSequence closingMarker
openingMarkerback to summary
protected BasedSequence openingMarker
referenceback to summary
protected BasedSequence reference

Constructor Detail

Referenceback to summary
public Reference(BasedSequence label, BasedSequence url, BasedSequence title)

Method Detail

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

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
getAnchorMarkerback to summary
public BasedSequence getAnchorMarker()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getAnchorMarker.

getAnchorRefback to summary
public BasedSequence getAnchorRef()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getAnchorRef.

getAstExtraback to summary
public void getAstExtra(@NotNull StringBuilder out)
Annotations
@Override
getClosingMarkerback to summary
public BasedSequence getClosingMarker()
getOpeningMarkerback to summary
public BasedSequence getOpeningMarker()
getPageRefback to summary
public BasedSequence getPageRef()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getPageRef.

getReferenceback to summary
public BasedSequence getReference()
getReferencingNodeback to summary
public @Nullable RefNode 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
getSegmentsForCharsback to summary
public @NotNull BasedSequence[] getSegmentsForChars()

Overrides com.vladsch.flexmark.util.ast.Node.getSegmentsForChars.

Doc from com.vladsch.flexmark.util.ast.Node.getSegmentsForChars.

Get the segments making up the node's characters.

Used to get segments after the some of the node's elements were modified

Returns:@NotNull BasedSequence[]

array of segments

Annotations
@NotNull
@Override
getTitleback to summary
public BasedSequence getTitle()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getTitle.

getTitleClosingMarkerback to summary
public BasedSequence getTitleClosingMarker()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getTitleClosingMarker.

getTitleOpeningMarkerback to summary
public BasedSequence getTitleOpeningMarker()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getTitleOpeningMarker.

getUrlback to summary
public BasedSequence getUrl()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getUrl.

getUrlClosingMarkerback to summary
public BasedSequence getUrlClosingMarker()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getUrlClosingMarker.

getUrlOpeningMarkerback to summary
public BasedSequence getUrlOpeningMarker()

Overrides com.vladsch.flexmark.ast.LinkNodeBase.getUrlOpeningMarker.

setAnchorMarkerback to summary
public void setAnchorMarker(BasedSequence anchorMarker)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setAnchorMarker.

setAnchorRefback to summary
public void setAnchorRef(BasedSequence anchorRef)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setAnchorRef.

setClosingMarkerback to summary
public void setClosingMarker(BasedSequence closingMarker)
setOpeningMarkerback to summary
public void setOpeningMarker(BasedSequence openingMarker)
setPageRefback to summary
public void setPageRef(BasedSequence pageRef)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setPageRef.

setReferenceback to summary
public void setReference(BasedSequence reference)
setTitleback to summary
public void setTitle(BasedSequence title)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setTitle.

setTitleClosingMarkerback to summary
public void setTitleClosingMarker(BasedSequence titleClosingMarker)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setTitleClosingMarker.

setTitleOpeningMarkerback to summary
public void setTitleOpeningMarker(BasedSequence titleOpeningMarker)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setTitleOpeningMarker.

setUrlback to summary
public void setUrl(BasedSequence url)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setUrl.

setUrlClosingMarkerback to summary
public void setUrlClosingMarker(BasedSequence urlClosingMarker)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setUrlClosingMarker.

setUrlOpeningMarkerback to summary
public void setUrlOpeningMarker(BasedSequence urlOpeningMarker)

Overrides com.vladsch.flexmark.ast.LinkNodeBase.setUrlOpeningMarker.

toStringAttributesback to summary
protected @NotNull String toStringAttributes()

Overrides com.vladsch.flexmark.util.ast.Node.toStringAttributes.

Annotations
@NotNull
@Override