1/*
2 * Copyright (C) 2012 Google Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
5 * use this file except in compliance with the License. You may obtain a copy of
6 * the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations under
14 * the License.
15 */
16
17package com.googlecode.eyesfree.braille.translate;
18
19/**
20 * Translates from text to braille and the other way according to a
21 * particular translation table.
22 */
23public interface BrailleTranslator {
24    /**
25     * Translates a string into the corresponding dot patterns and returns the
26     * resulting byte array.  Returns {@code null} on error.
27     */
28    byte[] translate(String text);
29
30    /**
31     * Translates the braille {@code cells} into the corresponding text, which
32     * is returned.  Returns {@code null} on error.
33     */
34    String backTranslate(byte[] cells);
35}
36