Package org.daisy.dotify.formatter.impl.segment

Class AnchorSegment

java.lang.Object

org.daisy.dotify.formatter.impl.segment.AnchorSegment

All Implemented Interfaces:

FollowingText, PrecedingText, ResolvableText, Segment

public class AnchorSegment
extends Object
implements Segment

TODO: Write java doc.

Nested Class Summary

Nested classes/interfaces inherited from interface org.daisy.dotify.formatter.impl.segment.Segment

Segment.SegmentType

Constructor Summary

Constructors

Constructor	Description
AnchorSegment(String referenceID)

Method Summary

Modifier and Type	Method	Description
String	getReferenceID()
Segment.SegmentType	getSegmentType()
boolean	isStatic()	Returns true if this item does not change.
String	peek()	Peeks the value of this item.
String	resolve()	Resolves the item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.daisy.dotify.formatter.impl.segment.Segment

getLocale, shouldHyphenate, shouldMarkCapitalLetters

Constructor Detail

AnchorSegment

public AnchorSegment(String referenceID)

Method Detail

getSegmentType

public Segment.SegmentType getSegmentType()

Specified by:

getSegmentType in interface Segment

getReferenceID

public String getReferenceID()

peek

public String peek()

Description copied from interface: ResolvableText

Peeks the value of this item. The returned string may be different from call to call.

Note that after a call to ResolvableText.resolve(), this method should consistently return the same result.

Specified by:

peek in interface FollowingText

Specified by:

peek in interface ResolvableText

Returns:

the value, never null

resolve

public String resolve()

Description copied from interface: ResolvableText

Resolves the item. Once the value has been resolved, it cannot change between calls in the same context. This applies to both ResolvableText.peek() and ResolvableText.resolve().

Specified by:

resolve in interface PrecedingText

Specified by:

resolve in interface ResolvableText

Returns:

the value, never null

isStatic

public boolean isStatic()

Description copied from interface: FollowingText

Returns true if this item does not change.

Specified by:

isStatic in interface FollowingText

Returns:

true if this item is static, false otherwise