org.daisy.dotify.api.formatter

Class Marker

java.lang.Object

org.daisy.dotify.api.formatter.Marker

public class Marker
extends Object

A Marker is a reference data inserted at some point in the flow. It can be used to create running headers/footers.

Constructor Summary

Constructors

Constructor and Description
Marker(String name, String value) Create a new Marker with the given name and value.

Method Summary

Modifier and Type	Method and Description
String	getName() Get the name of this Marker.
String	getValue() Get the value of this Marker

Methods inherited from class java.lang.Object

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

Constructor Detail

Marker

public Marker(String name,
              String value)

Create a new Marker with the given name and value.

Marker names are used when finding references for e.g. headers and footers and are generally not unique. Instead, think of marker names as "type" or "class".

Parameters:

name - the name of the Marker

value - the Marker value

Method Detail

getName

public String getName()

Get the name of this Marker. Note that marker names are not at all unique.

Returns:

returns the name of this Marker

getValue

public String getValue()

Get the value of this Marker

Returns:

returns this Marker's value