Package org.daisy.dotify.api.formatter

Class MarkerIndicatorRegion.Builder

java.lang.Object

org.daisy.dotify.api.formatter.MarkerIndicatorRegion.Builder

Enclosing class:

MarkerIndicatorRegion

public static class MarkerIndicatorRegion.Builder
extends Object

Creates a new marker indicator region builder.

Constructor Summary

Constructors

Constructor	Description
Builder(int width)	Creates a new builder with the specified width.

Method Summary

Modifier and Type	Method	Description
MarkerIndicatorRegion.Builder	addIndicator(String name, String indicator, String textStyle)	Adds a new marker indicator.
MarkerIndicatorRegion	build()	Builds the builder into a marker indicator region.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(int width)

Creates a new builder with the specified width.

Parameters:

width - the width of the column, in characters

Method Detail

addIndicator

public MarkerIndicatorRegion.Builder addIndicator(String name,
                                                  String indicator,
                                                  String textStyle)

Adds a new marker indicator.

Parameters:

name - the name of the markers to indicate

indicator - the string indicating an occurrence

textStyle - the text style

Returns:

a new builder

Throws:

IllegalStateException - if the builder has already transitioned to the built state

build

public MarkerIndicatorRegion build()

Builds the builder into a marker indicator region.

Returns:

returns a new marker indicator region

Throws:

IllegalStateException - if the builder has already transitioned to the built state