Java String Escape addEscapesToCode(String code)

Description

Adds escape characters to all occurences of ", \ and \n.

License

Open Source License

Parameter

Parameter	Description
code	code

Return

code with escape characters

Declaration

public static String addEscapesToCode(String code) 

Method Source Code

//package com.java2s;
/* //  www  .j  ava2s .  co  m
 * VLangUtils.java
 * 
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2009?2012 Steinbeis Forschungszentrum (STZ ?lbronn),
 * Copyright (c) 2006?2012 by Michael Hoffer
 * 
 * This file is part of Visual Reflection Library (VRL).
 *
 * VRL is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.
 * 
 * see: http://opensource.org/licenses/LGPL-3.0
 *      file://path/to/VRL/src/eu/mihosoft/vrl/resources/license/lgplv3.txt
 *
 * VRL is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * This version of VRL includes copyright notice and attribution requirements.
 * According to the LGPL this information must be displayed even if you modify
 * the source code of VRL. Neither the VRL Canvas attribution icon nor any
 * copyright statement/attribution may be removed.
 *
 * Attribution Requirements:
 *
 * If you create derived work you must do three things regarding copyright
 * notice and author attribution.
 *
 * First, the following text must be displayed on the Canvas:
 * "based on VRL source code". In this case the VRL canvas icon must be removed.
 * 
 * Second, the copyright notice must remain. It must be reproduced in any
 * program that uses VRL.
 *
 * Third, add an additional notice, stating that you modified VRL. In addition
 * you must cite the publications listed below. A suitable notice might read
 * "VRL source code modified by YourName 2012".
 * 
 * Note, that these requirements are in full accordance with the LGPL v3
 * (see 7. Additional Terms, b).
 *
 * Publications:
 *
 * M. Hoffer, C.Poliwoda, G.Wittum. Visual Reflection Library -
 * A Framework for Declarative GUI Programming on the Java Platform.
 * Computing and Visualization in Science, 2011, in press.
 */

public class Main {
    /**
     * Adds escape characters to all occurences of <code>"</code>,
     * <code>\</code> and <code>\n</code>.
     *
     * @param code code
     * @return code with escape characters
     */
    public static String addEscapesToCode(String code) {
        code = addEscapeCharsToBackSlash(code);
        code = addEscapeNewLinesToCode(code);
        return addEscapeCharsToCode(code);
    }

    /**
     * Adds escape characters to all occurences of <code>\</code>.
     *
     * @param code code
     * @return code with escape characters
     */
    public static String addEscapeCharsToBackSlash(String code) {
        if (code == null) {
            code = "";
        }

        // windows backslashes
        return code.replace("\\", "\\\\");
    }

    /**
     * Adds escape characters to all occurences of <code>\n</code>.
     *
     * @param code code
     * @return code with escape characters
     */
    public static String addEscapeNewLinesToCode(String code) {
        if (code == null) {
            code = "";
        }

        return code.replace("\n", "\\n");
    }

    /**
     * Adds escape characters to all occurences of <code>"</code>.
     *
     * @param code code
     * @return code with escape characters
     */
    public static String addEscapeCharsToCode(String code) {
        if (code == null) {
            code = "";
        }

        return code.replace("\"", "\\\"");
    }
}

Related

1. addEscapeCharactersForSpaces(String s)
2. addEscapeCharsToBackSlash(String code)
3. addEscapes(String s)
4. addEscapes(String str)
5. addEscapeSequence(String inputStr)
6. addEscChar(String str)
7. escape(final @Nonnull String string)
8. escape(final String s)
9. escape(final String value)