fr.paris.lutece.util.string
Class StringUtil

java.lang.Object
  extended by fr.paris.lutece.util.string.StringUtil

public final class StringUtil
extends Object

This class provides String utils.


Method Summary
static boolean checkAccentuatedCharacter(String strString)
          This function checks if an string is in a valid format Returns true if the string is valid
static boolean checkCodeKey(String strCodeKey)
          Check a code key.
static boolean checkEmail(String strEmail)
          This function checks if an email is in a valid format Returns true if the email is valid
static boolean checkEmailAndDomainName(String strEmail, String[] strBannedDomainNames)
          This function checks if an email is in a valid format, and is not in a banned domain names list.
static boolean checkEmailDomainName(String strEmail, String[] strBannedDomainNames)
          Check if a domain name of an email address is not in a banned domain names list.
static boolean containsHtmlSpecialCharacters(String strValue)
          Checks if a string literal contains any HTML special characters (&, ", ' <, >).
static boolean containsXssCharacters(String strValue)
          Checks if a String contains characters that could be used for a cross-site scripting attack.
static boolean containsXssCharacters(String strValue, char[] aXssCharacters)
          Checks if a String contains characters that could be used for a cross-site scripting attack.
static boolean containsXssCharacters(String strValue, String strXssCharacters)
          Checks if a String contains characters that could be used for a cross-site scripting attack.
static int getIntValue(String strValue, int nDefaultValue)
          Converts strValue to an int value.
static String getXssCharactersAsString()
          Simple convenience method to return the XSS characters as a string, to include it in error messages.
static String replaceAccent(String strInit)
          This function converts French diacritics characters into non diacritics.
static String substitute(String strSource, String strValue, String strBookmark)
          This function substitutes all occurences of a given bookmark by a given value
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

substitute

public static String substitute(String strSource,
                                String strValue,
                                String strBookmark)
This function substitutes all occurences of a given bookmark by a given value

Parameters:
strSource - The input string that contains bookmarks to replace
strValue - The value to substitute to the bookmark
strBookmark - The bookmark name
Returns:
The output string.

replaceAccent

public static String replaceAccent(String strInit)
This function converts French diacritics characters into non diacritics.

Parameters:
strInit - The String to convert
Returns:
The sTring converted to French non diacritics characters

containsHtmlSpecialCharacters

public static boolean containsHtmlSpecialCharacters(String strValue)
Checks if a string literal contains any HTML special characters (&, ", ' <, >).

Parameters:
strValue - The string literal to check
Returns:
True if the string literal contains any special character

containsXssCharacters

public static boolean containsXssCharacters(String strValue)
Checks if a String contains characters that could be used for a cross-site scripting attack.

Parameters:
strValue - a character String
Returns:
true if the String contains illegal characters

containsXssCharacters

public static boolean containsXssCharacters(String strValue,
                                            char[] aXssCharacters)
Checks if a String contains characters that could be used for a cross-site scripting attack.

Parameters:
strValue - a character String
aXssCharacters - a Xss characters tab to check in strValue
Returns:
true if the String contains illegal characters

containsXssCharacters

public static boolean containsXssCharacters(String strValue,
                                            String strXssCharacters)
Checks if a String contains characters that could be used for a cross-site scripting attack.

Parameters:
strValue - a character String
strXssCharacters - a String wich contain a list of Xss characters to check in strValue
Returns:
true if the String contains illegal characters

getXssCharactersAsString

public static String getXssCharactersAsString()
Simple convenience method to return the XSS characters as a string, to include it in error messages.

Returns:
a String containing a comma-separated list of the XSS characters

checkEmail

public static boolean checkEmail(String strEmail)
This function checks if an email is in a valid format Returns true if the email is valid

Parameters:
strEmail - The mail to check
Returns:
boolean true if strEmail is valid

checkEmailAndDomainName

public static boolean checkEmailAndDomainName(String strEmail,
                                              String[] strBannedDomainNames)
This function checks if an email is in a valid format, and is not in a banned domain names list. Returns true if the email is valid

Parameters:
strEmail - The mail to check
strBannedDomainNames - The list of banned domain names. Domain names may start with a '@' or not.
Returns:
boolean true if strEmail is valid, false otherwise

checkEmailDomainName

public static boolean checkEmailDomainName(String strEmail,
                                           String[] strBannedDomainNames)
Check if a domain name of an email address is not in a banned domain names list.

Parameters:
strEmail - Email addresse to check
strBannedDomainNames - List of banned domain names
Returns:
True if the email address is correct, false otherwise

checkAccentuatedCharacter

public static boolean checkAccentuatedCharacter(String strString)
This function checks if an string is in a valid format Returns true if the string is valid

Parameters:
strString - The string to check
Returns:
boolean true if r is valid

checkCodeKey

public static boolean checkCodeKey(String strCodeKey)
Check a code key.
Return true if each character of String is

Parameters:
strCodeKey - The code Key
Returns:
True if code key is valid

getIntValue

public static int getIntValue(String strValue,
                              int nDefaultValue)
Converts strValue to an int value.

Parameters:
strValue - the value to convert
nDefaultValue - the default returned value
Returns:
strValue int value, nDefaultValue if strValue is not an Integer.


Copyright © 2014 Mairie de Paris. All Rights Reserved.