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

Class MarkerReferenceSegment

java.lang.Object

org.daisy.dotify.formatter.impl.segment.MarkerReferenceSegment

All Implemented Interfaces:

FollowingText, PrecedingText, ResolvableText, Segment

public class MarkerReferenceSegment
extends Object
implements Segment

Provides a marker 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
MarkerReferenceSegment(Iterable<? extends MarkerReference> ref, TextProperties props)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Optional<String>	getLocale()
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<Iterable<? extends MarkerReference>,String> v)
boolean	shouldHyphenate()

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

shouldMarkCapitalLetters

Constructor Detail

MarkerReferenceSegment

public MarkerReferenceSegment(Iterable<? extends MarkerReference> ref,
                              TextProperties props)

Method Detail

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<Iterable<? extends MarkerReference>,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

getLocale

public Optional<String> getLocale()

Specified by:

getLocale in interface Segment

shouldHyphenate

public boolean shouldHyphenate()

Specified by:

shouldHyphenate in interface Segment