Package org.daisy.braille.table
Class EmbosserBrailleConverter
- java.lang.Object
-
- org.daisy.braille.table.EmbosserBrailleConverter
-
- All Implemented Interfaces:
BrailleConverter
public class EmbosserBrailleConverter extends java.lang.Object implements BrailleConverter
Provides a simple TableConverter implementation. It provides a one-to-one mapping between braille and text and vice versa.- Author:
- Joel HÃ¥kansson
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EmbosserBrailleConverter.EightDotFallbackMethod
Defines the fallback action when a character in the range 0x2840-0x28FF is encountered.
-
Constructor Summary
Constructors Constructor Description EmbosserBrailleConverter(java.lang.String table, java.nio.charset.Charset charset, EmbosserBrailleConverter.EightDotFallbackMethod fallback, char replacement, boolean ignoreCase)
Creates a new EmbosserBrailleConverter
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.nio.charset.Charset
getPreferredCharset()
Gets the preferred charset for this braille format when reading/writing as text from/to fileboolean
supportsEightDot()
Returns true if 8-dot braille is supported, false otherwisejava.lang.String
toBraille(java.lang.String text)
Transcodes the given text string as braille.java.lang.String
toText(java.lang.String braille)
Transcodes the given braille into text.
-
-
-
Constructor Detail
-
EmbosserBrailleConverter
public EmbosserBrailleConverter(java.lang.String table, java.nio.charset.Charset charset, EmbosserBrailleConverter.EightDotFallbackMethod fallback, char replacement, boolean ignoreCase)
Creates a new EmbosserBrailleConverter- Parameters:
table
- the characters in the table, in Unicode order. Must contain 64 or 256 characters.charset
- the preferred charset as defined in the BrailleConverter interfacefallback
- the fallback method to use when encountering a character in the range 0x2840-0x28FFreplacement
- the replacement character, must be in the range 0x2800-0x283FignoreCase
- set to true to ignore character case
-
-
Method Detail
-
getPreferredCharset
public java.nio.charset.Charset getPreferredCharset()
Description copied from interface:BrailleConverter
Gets the preferred charset for this braille format when reading/writing as text from/to file- Specified by:
getPreferredCharset
in interfaceBrailleConverter
- Returns:
- returns the preferred charset
-
supportsEightDot
public boolean supportsEightDot()
Description copied from interface:BrailleConverter
Returns true if 8-dot braille is supported, false otherwise- Specified by:
supportsEightDot
in interfaceBrailleConverter
- Returns:
- returns true if 8-dot braille is supported, false otherwise
-
toBraille
public java.lang.String toBraille(java.lang.String text)
Description copied from interface:BrailleConverter
Transcodes the given text string as braille. This may be a one-to-one mapping or a many-to-one depending on the table implementation.- Specified by:
toBraille
in interfaceBrailleConverter
- Returns:
- returns a Unicode string of braille
-
toText
public java.lang.String toText(java.lang.String braille)
Description copied from interface:BrailleConverter
Transcodes the given braille into text. In most cases this will reverse the effect of toBraille(String text), i.e. text.equals(toText(toBraille(text))), however an implementation cannot rely on it. Values must be between 0x2800 and 0x28FF.- Specified by:
toText
in interfaceBrailleConverter
- Returns:
- returns a text string
-
-