1 /**
2 The contents of this file are subject to the Mozilla Public License Version 1.1
3 (the "License"); you may not use this file except in compliance with the License.
4 You may obtain a copy of the License at http://www.mozilla.org/MPL/
5 Software distributed under the License is distributed on an "AS IS" basis,
6 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
7 specific language governing rights and limitations under the License.
8
9 The Original Code is "Escapin.java". Description:
10 "Interface for handling "escaping" and "unescaping" of text according to the HL7 escape sequence rules
11 defined in section 2.10 of the standard (version 2.4)"
12
13 The Initial Developer of the Original Code is University Health Network. Copyright (C)
14 2001. All Rights Reserved.
15
16 Contributor(s): Mark Lee (Skeva Technologies); Elmar Hinz
17
18 Alternatively, the contents of this file may be used under the terms of the
19 GNU General Public License (the "GPL"), in which case the provisions of the GPL are
20 applicable instead of those above. If you wish to allow use of your version of this
21 file only under the terms of the GPL and not to allow others to use your version
22 of this file under the MPL, indicate your decision by deleting the provisions above
23 and replace them with the notice and other provisions required by the GPL License.
24 If you do not delete the provisions above, a recipient may use your version of
25 this file under either the MPL or the GPL.
26 */
27 package ca.uhn.hl7v2.parser;
28
29 /**
30 * Handles "escaping" and "unescaping" of text according to the HL7 escape
31 * sequence rules defined in section 2.10 of the standard (version 2.4).
32 *
33 * @author Christian Ohr
34 */
35 public interface Escaping {
36
37 /**
38 * @param text string to be escaped
39 * @param encChars encoding characters to be used
40 * @return the escaped string
41 */
42 String escape(String text, EncodingCharacters encChars);
43
44 /**
45 * @param text string to be unescaped
46 * @param encChars encoding characters to be used
47 * @return the unescaped string
48 */
49 String unescape(String text, EncodingCharacters encChars);
50 }