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

Class ConfigurableEmbosser

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, AutoCloseable, EmbosserWriter, EmbosserWriterProperties

public class ConfigurableEmbosser
extends AbstractEmbosserWriter

Provides a configurable embosser. Outputs to a single OutputStream.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigurableEmbosser.Builder	Provides a builder for ConfigurableEmbosser.

Nested classes/interfaces inherited from class org.daisy.braille.utils.impl.tools.embosser.AbstractEmbosserWriter

AbstractEmbosserWriter.Padding

Field Summary

Fields inherited from class org.daisy.braille.utils.impl.tools.embosser.AbstractEmbosserWriter

pagebreaks, props

Method Summary

Modifier and Type	Method	Description
protected void	addAll(byte[] bytes)	Adds bytes to the EmbosserWriter output.
void	close()
protected void	formFeed()	Performs a form feed on the EmbosserWriter.
byte[]	getBytes(String braille)	Translates a string of braille into bytes that should be transfered to the embosser.
LineBreaks	getLinebreakStyle()	Gets the line break style for the EmbosserWriter.
AbstractEmbosserWriter.Padding	getPaddingStyle()	Gets the form feed padding style for the EmbosserWriter.
void	open(boolean duplex)	Opens for writing using the default contract.

Methods inherited from class org.daisy.braille.utils.impl.tools.embosser.AbstractEmbosserWriter

currentPage, getMaxWidth, getPagebreakStyle, getRowGap, init, isClosed, isOpen, lineFeed, newLine, newPage, newSectionAndPage, newVolumeSectionAndPage, pageIsEmpty, setRowGap, supportsAligning, write

Methods inherited from class java.lang.Object

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

Method Detail

formFeed

protected void formFeed()
                 throws IOException

Description copied from class: AbstractEmbosserWriter

Performs a form feed on the EmbosserWriter.

Overrides:

formFeed in class AbstractEmbosserWriter

Throws:

IOException - if IO fails

addAll

protected void addAll(byte[] bytes)
               throws IOException

Description copied from class: AbstractEmbosserWriter

Adds bytes to the EmbosserWriter output.

Specified by:

addAll in class AbstractEmbosserWriter

Parameters:

bytes - the bytes to add

Throws:

IOException - if IO fails

getBytes

public byte[] getBytes(String braille)
                throws UnsupportedEncodingException

Description copied from class: AbstractEmbosserWriter

Translates a string of braille into bytes that should be transfered to the embosser.

Specified by:

getBytes in class AbstractEmbosserWriter

Parameters:

braille - the braille (characters in the Braille Patterns unicode block 0x2800-0x28FF).

Returns:

the bytes

Throws:

UnsupportedEncodingException - if the string could not be encoded.

getLinebreakStyle

public LineBreaks getLinebreakStyle()

Description copied from class: AbstractEmbosserWriter

Gets the line break style for the EmbosserWriter.

Specified by:

getLinebreakStyle in class AbstractEmbosserWriter

Returns:

returns the line break style for the EmbosserWriter

getPaddingStyle

public AbstractEmbosserWriter.Padding getPaddingStyle()

Description copied from class: AbstractEmbosserWriter

Gets the form feed padding style for the EmbosserWriter.

Specified by:

getPaddingStyle in class AbstractEmbosserWriter

Returns:

returns the padding style for the EmbosserWriter

open

public void open(boolean duplex)
          throws IOException

Description copied from interface: EmbosserWriter

Opens for writing using the default contract.

Specified by:

open in interface EmbosserWriter

Overrides:

open in class AbstractEmbosserWriter

Parameters:

duplex - true if both sides of sheets should be used, false otherwise

Throws:

IOException - if an I/O error occurs

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class AbstractEmbosserWriter

Throws:

IOException