SequenceProperties.Builder (dotify.api 5.0.0 API)

java.lang.Object
- org.daisy.dotify.api.formatter.SequenceProperties.Builder

Direct Known Subclasses:

TocProperties.Builder

Enclosing class:

SequenceProperties
```
public static class SequenceProperties.Builder
extends Object
```
The Builder is used when creating a SequenceProperites instance

Constructor Summary

Constructors
Constructor Description

Builder(String masterName)
Create a new Builder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SequenceProperties.Builder`	`breakBefore(SequenceProperties.SequenceBreakBefore value)`	Set the break before property for the sequence.
`SequenceProperties`	`build()`	Build SequenceProperties using the current state of the Builder
`SequenceProperties.Builder`	`initialPageNumber(int value)`	Set the initialPageNumber for the SequenceProperties instances created using this Builder
`SequenceProperties.Builder`	`pageCounterName(String value)`	Sets the page counter name for the sequence.

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)
```
    Create a new Builder
    
    Parameters:
    
    masterName - the master name for SequenceProperties instances created using this Builder
- Method Detail
  - initialPageNumber
```
public SequenceProperties.Builder initialPageNumber(int value)
```
    Set the initialPageNumber for the SequenceProperties instances created using this Builder
    
    Parameters:
    
    value - the value
    
    Returns:
    
    returns the Builder
  - breakBefore
```
public SequenceProperties.Builder breakBefore(SequenceProperties.SequenceBreakBefore value)
```
    Set the break before property for the sequence.
    
    Parameters:
    
    value - the break before type
    
    Returns:
    
    returns "this" object
  - pageCounterName
```
public SequenceProperties.Builder pageCounterName(String value)
```
    Sets the page counter name for the sequence. When this value is set, pages in the sequence are counted separately (in other words, not using the default page counter). Instead, pages are counted together with other sequences having the same page counter name.
    
    Parameters:
    
    value - the identifier
    
    Returns:
    
    returns "this" object
  - build
```
public SequenceProperties build()
```
    Build SequenceProperties using the current state of the Builder
    
    Returns:
    
    returns a new SequenceProperties instance