src-main.org.awakefw.file.api.util.HtmlConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of awake-file Show documentation

Awake FILE is a secure Open Source framework that allows to program very easily file uploads/downloads and RPC through http. File transfers include powerful features like file chunking and automatic recovery mechanism. Security has been taken into account from the design: server side allows to specify strong security rules in order to protect the files and to secure the RPC calls.

There is a newer version: 3.0

Show newest version

/*
 * This file is part of Awake FILE. 
 * Awake FILE: Easy file upload & download over HTTP with Java.                                    
 * Copyright (C) 2014,  KawanSoft SAS
 * (http://www.kawansoft.com). All rights reserved.                                
 *                                                                               
 * Awake FILE is free software; you can redistribute it and/or                 
 * modify it under the terms of the GNU Lesser General Public                    
 * License as published by the Free Software Foundation; either                  
 * version 2.1 of the License, or (at your option) any later version.            
 *                                                                               
 * Awake FILE 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.                               
 *                                                                               
 * You should have received a copy of the GNU Lesser General Public              
 * License along with this library; if not, write to the Free Software           
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  
 * 02110-1301  USA
 *
 * Any modifications to this file must keep this entire header
 * intact.
 */
package org.awakefw.file.api.util;

import java.util.List;
import java.util.Vector;

import org.apache.commons.lang3.StringEscapeUtils;
import org.apache.commons.lang3.text.translate.NumericEntityEscaper;

/**
 * Static methods to convert special characters to HTML equivalent and
 * vice-versa.
 * 
 * @author Nicolas de Pomereu
 * 
 */

public class HtmlConverter {
    /**
     * 
     * Converts special HTML values of characters to their original values. 

     * Example : "&eacute;""is converted to "?"
     * 
     * 
     * @param string
     *            A String to convert from HTML to original
     *            

     * @return A String of char converted to original values
     * 
     */

    public static String fromHtml(String string) {
	
	if (string == null) return string;
	    
	if (string.contains("&")) {
	    return StringEscapeUtils.unescapeHtml4(string);
	} else {
	    return string;
	}
	

    }

    /**
     * Converts special characters to their HTML values. 

     * Example : "?" is converted to "&eacute;"
     * 

     * 
     * @param string
     *            A String to convert from original to HTML
     *            

     * @return A String of char converted to HTML equivalent.
     * 
     */

    public static String toHtml(String string) {
		
	string = org.apache.commons.lang3.StringEscapeUtils.ESCAPE_HTML4.with(NumericEntityEscaper.between(0x7f, Integer.MAX_VALUE) ).translate(string); 

	if (string != null) {
	    string = string.replaceAll("&", "&"); // To keep same result if
						      // multi-call
	}
	
	return string;
    }

    /**
     * 
     * Converts special HTML values of characters to their original values. 

     * Example : "é"is converted to "?"
     * 

     * 
     * @param list
     *            A list of String to convert from HTML to original
     *            

     * @return A list of String char converted to original values
     * 
     */

    public static List fromHtml(List list) {

	List newList = new Vector();

	for (String string : list) {
	    string = HtmlConverter.fromHtml(string);
	    newList.add(string);
	}

	return newList;
    }

    /**
     * Converts special characters to their HTML values. 

     * Example : "?" is converted to "é"
     * 

     * 
     * @param list
     *            A list of String to convert from original to HTML
     *            
     * @return A list of String of char converted to HTML equivalent.
     * 
     */

    public static List toHtml(List list) {

	List newList = new Vector();

	for (String string : list) {
	    string = HtmlConverter.toHtml(string);
	    newList.add(string);
	}

	return newList;
    }

}