Package org.daisy.dotify.api.formatter

Class TocProperties.Builder

java.lang.Object

org.daisy.dotify.api.formatter.SequenceProperties.Builder

org.daisy.dotify.api.formatter.TocProperties.Builder

Enclosing class:

TocProperties

public static class TocProperties.Builder
extends SequenceProperties.Builder

Provides a builder for creating TOC properties instances.

Constructor Summary

Constructors

Constructor	Description
Builder(String masterName, String tocName, TocProperties.TocRange range)	Creates a new builder with the supplied arguments.

Method Summary

Modifier and Type	Method	Description
TocProperties	build()	Build SequenceProperties using the current state of the Builder.

Methods inherited from class org.daisy.dotify.api.formatter.SequenceProperties.Builder

breakBefore, initialPageNumber, pageCounterName

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String masterName,
               String tocName,
               TocProperties.TocRange range)

Creates a new builder with the supplied arguments.

Parameters:

masterName - the master identifier

tocName - the toc identifier

range - a range for the TOC

Method Detail

build

public TocProperties build()

Description copied from class: SequenceProperties.Builder

Build SequenceProperties using the current state of the Builder.

Overrides:

build in class SequenceProperties.Builder

Returns:

returns a new SequenceProperties instance