Package org.daisy.braille.utils.impl.tools.embosser

Class InternalContract

java.lang.Object

org.daisy.braille.utils.impl.tools.embosser.InternalContract

public class InternalContract
extends Object

Provides a usage contract that allows an implementation of EmbosserWriter to optimize or configure the communication based on properties of the actual data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalContract.BrailleRange	Defines a braille range.
static class	InternalContract.Builder	Provides a builder for Contract.
static class	InternalContract.PageMode	Defines a page mode.

Method Summary

Modifier and Type	Method	Description
InternalContract.BrailleRange	getBrailleRange()	Gets the braille range in this Contract.
Integer	getPages()	Gets the number of pages in this contract.
Set<Integer>	getRowGaps()	Gets the row gaps in this contract.
boolean	onlySimpleRowgaps()	Returns true if all row gaps in this contract are equal to full lines, In other words, row gaps that can be replaced with new lines.

Methods inherited from class java.lang.Object

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

Method Detail

getBrailleRange

public InternalContract.BrailleRange getBrailleRange()

Gets the braille range in this Contract.

Returns:

returns the braille range

getPages

public Integer getPages()

Gets the number of pages in this contract.

Returns:

returns the number of pages, or null if not set

getRowGaps

public Set<Integer> getRowGaps()

Gets the row gaps in this contract.

Returns:

returns the row gaps that will be used

onlySimpleRowgaps

public boolean onlySimpleRowgaps()

Returns true if all row gaps in this contract are equal to full lines, In other words, row gaps that can be replaced with new lines.

Returns:

true if all row gaps are full lines, false otherwise