001/**
002 The contents of this file are subject to the Mozilla Public License Version 1.1
003 (the "License"); you may not use this file except in compliance with the License.
004 You may obtain a copy of the License at http://www.mozilla.org/MPL/
005 Software distributed under the License is distributed on an "AS IS" basis,
006 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
007 specific language governing rights and limitations under the License.
008
009 The Original Code is "Escapin.java".  Description:
010 "Interface for handling "escaping" and "unescaping" of text according to the HL7 escape sequence rules
011 defined in section 2.10 of the standard (version 2.4)"
012
013 The Initial Developer of the Original Code is University Health Network. Copyright (C)
014 2001.  All Rights Reserved.
015
016 Contributor(s): Mark Lee (Skeva Technologies); Elmar Hinz
017
018 Alternatively, the contents of this file may be used under the terms of the
019 GNU General Public License (the  "GPL"), in which case the provisions of the GPL are
020 applicable instead of those above.  If you wish to allow use of your version of this
021 file only under the terms of the GPL and not to allow others to use your version
022 of this file under the MPL, indicate your decision by deleting  the provisions above
023 and replace  them with the notice and other provisions required by the GPL License.
024 If you do not delete the provisions above, a recipient may use your version of
025 this file under either the MPL or the GPL.
026 */
027package ca.uhn.hl7v2.parser;
028
029/**
030 * Handles "escaping" and "unescaping" of text according to the HL7 escape
031 * sequence rules defined in section 2.10 of the standard (version 2.4).
032 *
033 * @author Christian Ohr
034 */
035public interface Escaping {
036
037    /**
038     * @param text string to be escaped
039     * @param encChars encoding characters to be used
040     * @return the escaped string
041     */
042    String escape(String text, EncodingCharacters encChars);
043
044    /**
045     * @param text string to be unescaped
046     * @param encChars encoding characters to be used
047     * @return the unescaped string
048     */
049    String unescape(String text, EncodingCharacters encChars);
050}