| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ArabicDecoder |
|
| 1.0;1 |
| 1 | /* Copyright (C) Kais Dukes, 2009. | |
| 2 | * | |
| 3 | * This file is part of JQuranTree. | |
| 4 | * | |
| 5 | * JQuranTree is free software: you can redistribute it and/or modify | |
| 6 | * it under the terms of the GNU General Public License as published by | |
| 7 | * the Free Software Foundation, either version 3 of the License, or | |
| 8 | * (at your option) any later version. | |
| 9 | * | |
| 10 | * JQuranTree is distributed in the hope that it will be useful, | |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 13 | * GNU General Public License for more details. | |
| 14 | * | |
| 15 | * You should have received a copy of the GNU General Public License | |
| 16 | * along with JQuranTree. If not, see <http://www.gnu.org/licenses/>. | |
| 17 | */ | |
| 18 | ||
| 19 | package org.jqurantree.arabic.encoding; | |
| 20 | ||
| 21 | /** | |
| 22 | * Interface for classes which decode {@link org.jqurantree.arabic.ArabicText}. | |
| 23 | * This interface is used to support the | |
| 24 | * {@link org.jqurantree.arabic.ArabicText#fromEncoding(String, EncodingType)} | |
| 25 | * method. | |
| 26 | * | |
| 27 | * @author Kais Dukes | |
| 28 | */ | |
| 29 | public interface ArabicDecoder { | |
| 30 | ||
| 31 | /** | |
| 32 | * Decodes a plain text <code>string</code> into the internal | |
| 33 | * {@link org.jqurantree.arabic.ByteFormat} according to the encoding | |
| 34 | * scheme. | |
| 35 | * | |
| 36 | * @param text | |
| 37 | * the plain text <code>string</code> to decode | |
| 38 | * | |
| 39 | * @return a <code>byte[]</code> array in the internal | |
| 40 | * {@link org.jqurantree.arabic.ByteFormat} | |
| 41 | */ | |
| 42 | public byte[] decode(String text); | |
| 43 | } |