Java XML Encode encodeXML(String text)

Description

Escape characters for text appearing as XML data, between tags.

License

Apache License

Parameter

Parameter	Description
text	Input text

Return

Encoded string

Declaration

public static String encodeXML(String text) 

Method Source Code

//package com.java2s;
/*******************************************************************************
 * Software Name : RCS IMS Stack/*from w ww. ja  va  2  s  .  c o m*/
 *
 * Copyright (C) 2010 France Telecom S.A.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/

import java.text.CharacterIterator;
import java.text.StringCharacterIterator;

public class Main {
    /**
     * Escape characters for text appearing as XML data, between tags.
     * 
     * The following characters are replaced :
     * <br> <
     * <br> >
     * <br> &
     * <br> "
     * <br> '
     * 
     * @param text Input text
     * @return Encoded string
     */
    public static String encodeXML(String text) {
        if (text == null) {
            return null;
        }

        final StringBuilder result = new StringBuilder();
        final StringCharacterIterator iterator = new StringCharacterIterator(text);
        char character = iterator.current();
        while (character != CharacterIterator.DONE) {
            if (character == '<') {
                result.append("&lt;");
            } else if (character == '>') {
                result.append("&gt;");
            } else if (character == '\"') {
                result.append("&quot;");
            } else if (character == '\'') {
                result.append("&#039;");
            } else if (character == '&') {
                result.append("&amp;");
            } else {
                //the char is not a special one
                //add it to the result as is
                result.append(character);
            }
            character = iterator.next();
        }
        return result.toString();
    }
}

Related

1. textToXml(String text)
2. textToXML(String text)
3. toXMLCData(String cdata)
4. toXMLCharData(String javaString)