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

Class PageNumberReference

java.lang.Object

org.daisy.dotify.formatter.impl.segment.PageNumberReference

All Implemented Interfaces:

FollowingText, PrecedingText, ResolvableText, Segment

public class PageNumberReference
extends Object
implements Segment

Provides a page number reference event object.

Nested Class Summary

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

Segment.SegmentType

Constructor Summary

Constructors

Constructor	Description
PageNumberReference(String refid, NumeralStyle style, boolean markCapitalLetters)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
NumeralStyle	getNumeralStyle()	Gets the numeral style for this page number reference.
String	getRefId()	Gets the identifier to the reference location.
Segment.SegmentType	getSegmentType()
int	hashCode()
boolean	isStatic()	Returns true if this item does not change.
String	peek()	Peeks the value of this item.
String	resolve()	Resolves the item.
void	setResolver(Function<PageNumberReference,String> v)
boolean	shouldMarkCapitalLetters()

Methods inherited from class java.lang.Object

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

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

getLocale, shouldHyphenate

Constructor Detail

PageNumberReference

public PageNumberReference(String refid,
                           NumeralStyle style,
                           boolean markCapitalLetters)

Method Detail

getRefId

public String getRefId()

Gets the identifier to the reference location.

Returns:

returns the reference identifier

getNumeralStyle

public NumeralStyle getNumeralStyle()

Gets the numeral style for this page number reference.

Returns:

returns the numeral style

getSegmentType

public Segment.SegmentType getSegmentType()

Specified by:

getSegmentType in interface Segment

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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

setResolver

public void setResolver(Function<PageNumberReference,String> v)

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

shouldMarkCapitalLetters

public boolean shouldMarkCapitalLetters()

Specified by:

shouldMarkCapitalLetters in interface Segment