Class Validator

Object
com.liferay.portal.kernel.util.Validator

public class Validator extends Object
Provides utility methods related to data validation and format checking.
Author:
Brian Wing Shun Chan, Alysa Carver
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    equalsSorted(boolean[] booleanArray1, boolean[] booleanArray2)
    Returns true if the boolean arrays are equal.
    static boolean
    equalsSorted(byte[] byteArray1, byte[] byteArray2)
    Returns true if the byte arrays are equal.
    static boolean
    equalsSorted(char[] charArray1, char[] charArray2)
    Returns true if the char arrays are equal.
    static boolean
    equalsSorted(double[] doubleArray1, double[] doubleArray2)
    Returns true if the double arrays are equal.
    static boolean
    equalsSorted(float[] floatArray1, float[] floatArray2)
    Returns true if the float arrays are equal.
    static boolean
    equalsSorted(int[] intArray1, int[] intArray2)
    Returns true if the int arrays are equal.
    static boolean
    equalsSorted(long[] longArray1, long[] longArray2)
    Returns true if the long arrays are equal.
    static boolean
    equalsSorted(short[] shortArray1, short[] shortArray2)
    Returns true if the short arrays are equal.
    static boolean
    equalsSorted(Object[] objArray1, Object[] objArray2)
    Returns true if the object arrays are equal.
    static boolean
    isAddress(String address)
    Returns true if the string is an email address.
    static boolean
    Returns true if the string is an alphanumeric name, meaning it contains nothing but English letters, numbers, and spaces.
    static boolean
    isAscii(char c)
    Returns true if the character is in the ASCII character set.
    static boolean
     
    static boolean
     
    static boolean
    isChar(char c)
    Returns true if the character is an upper or lower case English letter.
    static boolean
    Returns true if string consists only of upper and lower case English letters.
    static boolean
    Returns true if the string contains content.
    static boolean
    isDate(int month, int day, int year)
    Returns true if the date is valid in the Gregorian calendar.
    static boolean
    isDigit(char c)
    Returns true if the character is a digit between 0 and 9 (inclusive).
    static boolean
    Returns true if the string consists of only digits between 0 and 9 (inclusive).
    static boolean
    isDomain(String domainName)
    Returns true if the string is a valid domain name.
    static boolean
    isEmailAddress(String emailAddress)
    Returns true if the string is a valid email address.
    static boolean
    Returns true if the character is a special character in an email address.
    static boolean
    isFileExtension(String fileExtension)
    Returns true if the file extension is valid.
    static boolean
     
    static boolean
    isFilePath(String path, boolean parentDirAllowed)
     
    static boolean
    isGregorianDate(int month, int day, int year)
    Returns true if the date is valid in the Gregorian calendar.
    static boolean
    Returns true if the string is a hexidecimal number.
    static boolean
    Returns true if the string is a valid host name.
    static boolean
    Returns true if the string is an HTML document.
    static boolean
    isIPAddress(String ipAddress)
    Returns true if the string is a valid IPv4 or IPv6 IP address.
    static boolean
    isIPv4Address(String ipAddress)
    Returns true if the string is a valid IPv4 IP address.
    static boolean
    isIPv6Address(String ipAddress)
    Returns true if the string is a valid IPv6 IP address.
    static boolean
    isJulianDate(int month, int day, int year)
    Returns true if the date is valid in the Julian calendar.
    static boolean
    isLUHN(String number)
    Returns true if the string contains a valid number according to the Luhn algorithm, commonly used to validate credit card numbers.
    static boolean
    isName(String name)
    Returns true if the string is a name, meaning it contains nothing but English letters and spaces.
    static boolean
    Returns true if the long number object is not null, meaning it is neither a null reference or zero.
    static boolean
    isNotNull(Object object)
    Returns true if the object is not null, using the rules from isNotNull(Long) or isNotNull(String) if the object is one of these types.
    static boolean
    Returns true if the string is not null, meaning it is not a null reference, an empty string, whitespace, or the string "null", with or without leading or trailing whitespace.
    static boolean
    Returns true if the long number object is null, meaning it is either a null reference or zero.
    static boolean
    isNull(Object object)
    Returns true if the object is null, using the rules from isNull(Long) or isNull(String) if the object is one of these types.
    static boolean
    Returns true if the string is null, meaning it is a null reference, an empty string, whitespace, or the string "null", with or without leading or trailing whitespace.
    static boolean
    isNumber(String number)
    Returns true if the string is a decimal integer number, meaning it contains nothing but decimal digits.
    static boolean
    isPassword(String password)
    Returns true if the string is a valid password, meaning it is at least four characters long and contains only letters and decimal digits.
    static boolean
    isPhoneNumber(String phoneNumber)
    Returns true if the string is a valid phone number.
    static boolean
     
    static boolean
    Returns true if the string is a valid URL based on the rules in URL.
    static boolean
    isUrl(String url, boolean acceptRootRelative)
    Returns true if the string is a valid URL based on the rules in URL.
    static boolean
    isVariableName(String variableName)
    Returns true if the string is a valid variable name in Java.
    static boolean
    Returns true if the string is a valid variable term, meaning it begins with "[$" and ends with "$]".
    static boolean
    isWhitespace(char c)
    Returns true if the character is whitespace, meaning it is either the null character '0' or whitespace according to Character.isWhitespace(char).
    static boolean
    Returns true if the string is an XML document.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Validator

      public Validator()
  • Method Details

    • equalsSorted

      public static boolean equalsSorted(boolean[] booleanArray1, boolean[] booleanArray2)
      Returns true if the boolean arrays are equal.
      Parameters:
      booleanArray1 - the first boolean array
      booleanArray2 - the second boolean array
      Returns:
      true if the booleans arrays are equal; false otherwise
    • equalsSorted

      public static boolean equalsSorted(byte[] byteArray1, byte[] byteArray2)
      Returns true if the byte arrays are equal.
      Parameters:
      byteArray1 - the first byte array
      byteArray2 - the second byte array
      Returns:
      true if the byte arrays are equal; false otherwise
    • equalsSorted

      public static boolean equalsSorted(char[] charArray1, char[] charArray2)
      Returns true if the char arrays are equal.
      Parameters:
      charArray1 - the first char array
      charArray2 - the second char array
      Returns:
      true if the char arrays are equal; false otherwise
    • equalsSorted

      public static boolean equalsSorted(double[] doubleArray1, double[] doubleArray2)
      Returns true if the double arrays are equal.
      Parameters:
      doubleArray1 - the first double array
      doubleArray2 - the second double array
      Returns:
      true if the double arrays are equal; false otherwise
    • equalsSorted

      public static boolean equalsSorted(float[] floatArray1, float[] floatArray2)
      Returns true if the float arrays are equal.
      Parameters:
      floatArray1 - the first float array
      floatArray2 - the second char array
      Returns:
      true if the float arrays are equal; false otherwise
    • equalsSorted

      public static boolean equalsSorted(int[] intArray1, int[] intArray2)
      Returns true if the int arrays are equal.
      Parameters:
      intArray1 - the first int array
      intArray2 - the second int array
      Returns:
      true if the int arrays are equal; false otherwise
    • equalsSorted

      public static boolean equalsSorted(long[] longArray1, long[] longArray2)
      Returns true if the long arrays are equal.
      Parameters:
      longArray1 - the first long array
      longArray2 - the second long array
      Returns:
      true if the long arrays are equal; false otherwise
    • equalsSorted

      public static boolean equalsSorted(Object[] objArray1, Object[] objArray2)
      Returns true if the object arrays are equal.
      Parameters:
      objArray1 - the first object array
      objArray2 - the second object array
      Returns:
      true if the object arrays are equal; false otherwise
    • equalsSorted

      public static boolean equalsSorted(short[] shortArray1, short[] shortArray2)
      Returns true if the short arrays are equal.
      Parameters:
      shortArray1 - the first short array
      shortArray2 - the second short array
      Returns:
      true if the short arrays are equal; false otherwise
    • isAddress

      public static boolean isAddress(String address)
      Returns true if the string is an email address. The only requirements are that the string consist of two parts separated by an @ symbol, and that it contain no whitespace.
      Parameters:
      address - the string to check
      Returns:
      true if the string is an email address; false otherwise
    • isAlphanumericName

      public static boolean isAlphanumericName(String name)
      Returns true if the string is an alphanumeric name, meaning it contains nothing but English letters, numbers, and spaces.
      Parameters:
      name - the string to check
      Returns:
      true if the string is an Alphanumeric name; false otherwise
    • isAscii

      public static boolean isAscii(char c)
      Returns true if the character is in the ASCII character set. This includes characters with integer values between 32 and 126 (inclusive).
      Parameters:
      c - the character to check
      Returns:
      true if the character is in the ASCII character set; false otherwise
    • isBlank

      public static boolean isBlank(String s)
    • isBoolean

      public static boolean isBoolean(String value)
    • isChar

      public static boolean isChar(char c)
      Returns true if the character is an upper or lower case English letter.
      Parameters:
      c - the character to check
      Returns:
      true if the character is an upper or lower case English letter; false otherwise
    • isChar

      public static boolean isChar(String s)
      Returns true if string consists only of upper and lower case English letters.
      Parameters:
      s - the string to check
      Returns:
      true if the string consists only of upper and lower case English letters
    • isContent

      public static boolean isContent(String s)
      Returns true if the string contains content. The only requirement is that it contain content that is not whitespace.
      Parameters:
      s - the string to check
      Returns:
      true if the string contains content; false otherwise
    • isDate

      public static boolean isDate(int month, int day, int year)
      Returns true if the date is valid in the Gregorian calendar.
      Parameters:
      month - the month to check
      day - the day to check
      year - the year to check
      Returns:
      true if the date is valid in the Gregorian calendar; false otherwise
    • isDigit

      public static boolean isDigit(char c)
      Returns true if the character is a digit between 0 and 9 (inclusive).
      Parameters:
      c - the character to check
      Returns:
      true if the character is a digit between 0 and 9 (inclusive); false otherwise
    • isDigit

      public static boolean isDigit(String s)
      Returns true if the string consists of only digits between 0 and 9 (inclusive).
      Parameters:
      s - the string to check
      Returns:
      true if the string consists of only digits between 0 and 9 (inclusive); false otherwise
    • isDomain

      public static boolean isDomain(String domainName)
      Returns true if the string is a valid domain name. See RFC-1034 (section 3), RFC-1123 (section 2.1), and RFC-952 (section B. Lexical grammar).
      Parameters:
      domainName - the string to check
      Returns:
      true if the string is a valid domain name; false otherwise
    • isEmailAddress

      public static boolean isEmailAddress(String emailAddress)
      Returns true if the string is a valid email address.
      Parameters:
      emailAddress - the string to check
      Returns:
      true if the string is a valid email address; false otherwise
    • isEmailAddressSpecialChar

      public static boolean isEmailAddressSpecialChar(char c)
      Returns true if the character is a special character in an email address.
      Parameters:
      c - the character to check
      Returns:
      true if the character is a special character in an email address; false otherwise
    • isFileExtension

      public static boolean isFileExtension(String fileExtension)
      Returns true if the file extension is valid.
      Parameters:
      fileExtension - string to check
      Returns:
      true if the extension is valid; false otherwise
    • isFileName

      public static boolean isFileName(String name)
    • isFilePath

      public static boolean isFilePath(String path, boolean parentDirAllowed)
    • isGregorianDate

      public static boolean isGregorianDate(int month, int day, int year)
      Returns true if the date is valid in the Gregorian calendar.
      Parameters:
      month - the month (0-based, meaning 0 for January)
      day - the day of the month
      year - the year
      Returns:
      true if the date is valid; false otherwise
    • isHex

      public static boolean isHex(String s)
      Returns true if the string is a hexidecimal number. At present the only requirement is that the string is not null; it does not actually check the format of the string.
      Parameters:
      s - the string to check
      Returns:
      true if the string is a hexidecimal number; false otherwise
      See Also:
    • isHostName

      public static boolean isHostName(String name)
      Returns true if the string is a valid host name.
      Parameters:
      name - the string to check
      Returns:
      true if the string is a valid host name; false otherwise
    • isHTML

      public static boolean isHTML(String s)
      Returns true if the string is an HTML document. The only requirement is that it contain the opening and closing html tags.
      Parameters:
      s - the string to check
      Returns:
      true if the string is an HTML document; false otherwise
    • isIPAddress

      public static boolean isIPAddress(String ipAddress)
      Returns true if the string is a valid IPv4 or IPv6 IP address.
      Parameters:
      ipAddress - the string to check
      Returns:
      true if the string is a valid IPv4 or IPv6 IP address; false otherwise
    • isIPv4Address

      public static boolean isIPv4Address(String ipAddress)
      Returns true if the string is a valid IPv4 IP address.
      Parameters:
      ipAddress - the string to check
      Returns:
      true if the string is a valid IPv4 IP address; false otherwise
    • isIPv6Address

      public static boolean isIPv6Address(String ipAddress)
      Returns true if the string is a valid IPv6 IP address.
      Parameters:
      ipAddress - the string to check
      Returns:
      true if the string is a valid IPv6 IP address; false otherwise
    • isJulianDate

      public static boolean isJulianDate(int month, int day, int year)
      Returns true if the date is valid in the Julian calendar.
      Parameters:
      month - the month (0-based, meaning 0 for January)
      day - the day of the month
      year - the year
      Returns:
      true if the date is valid in the Julian calendar; false otherwise
    • isLUHN

      public static boolean isLUHN(String number)
      Returns true if the string contains a valid number according to the Luhn algorithm, commonly used to validate credit card numbers.
      Parameters:
      number - the string to check
      Returns:
      true if the string contains a valid number according to the Luhn algorithm; false otherwise
    • isName

      public static boolean isName(String name)
      Returns true if the string is a name, meaning it contains nothing but English letters and spaces.
      Parameters:
      name - the string to check
      Returns:
      true if the string is a name; false otherwise
    • isNotNull

      public static boolean isNotNull(Long l)
      Returns true if the long number object is not null, meaning it is neither a null reference or zero.
      Parameters:
      l - the long number object to check
      Returns:
      true if the long number object is not null; false otherwise
    • isNotNull

      public static boolean isNotNull(Object object)
      Returns true if the object is not null, using the rules from isNotNull(Long) or isNotNull(String) if the object is one of these types.
      Parameters:
      object - the object to check
      Returns:
      true if the object is not null; false otherwise
    • isNotNull

      public static boolean isNotNull(String s)
      Returns true if the string is not null, meaning it is not a null reference, an empty string, whitespace, or the string "null", with or without leading or trailing whitespace.
      Parameters:
      s - the string to check
      Returns:
      true if the string is not null; false otherwise
    • isNull

      public static boolean isNull(Long l)
      Returns true if the long number object is null, meaning it is either a null reference or zero.
      Parameters:
      l - the long number object to check
      Returns:
      true if the long number object is null; false otherwise
    • isNull

      public static boolean isNull(Object object)
      Returns true if the object is null, using the rules from isNull(Long) or isNull(String) if the object is one of these types.
      Parameters:
      object - the object to check
      Returns:
      true if the object is null; false otherwise
    • isNull

      public static boolean isNull(String s)
      Returns true if the string is null, meaning it is a null reference, an empty string, whitespace, or the string "null", with or without leading or trailing whitespace.
      Parameters:
      s - the string to check
      Returns:
      true if the string is null; false otherwise
    • isNumber

      public static boolean isNumber(String number)
      Returns true if the string is a decimal integer number, meaning it contains nothing but decimal digits.
      Parameters:
      number - the string to check
      Returns:
      true if the string is a decimal integer number; false otherwise
    • isPassword

      public static boolean isPassword(String password)
      Returns true if the string is a valid password, meaning it is at least four characters long and contains only letters and decimal digits.
      Parameters:
      password - the string to check
      Returns:
      true if the string is a valid password; false otherwise
    • isPhoneNumber

      public static boolean isPhoneNumber(String phoneNumber)
      Returns true if the string is a valid phone number. The only requirement is that there are decimal digits in the string; length and format are not checked.
      Parameters:
      phoneNumber - the string to check
      Returns:
      true if the string is a valid phone number; false otherwise
    • isUri

      public static boolean isUri(String uri)
    • isUrl

      public static boolean isUrl(String url)
      Returns true if the string is a valid URL based on the rules in URL.
      Parameters:
      url - the string to check
      Returns:
      true if the string is a valid URL; false otherwise
    • isUrl

      public static boolean isUrl(String url, boolean acceptRootRelative)
      Returns true if the string is a valid URL based on the rules in URL. This method can also validate root relative URLs.
      Parameters:
      url - the string to check
      acceptRootRelative - whether a root relative URL should be accepted
      Returns:
      true if the string is a valid URL; false otherwise
    • isVariableName

      public static boolean isVariableName(String variableName)
      Returns true if the string is a valid variable name in Java.
      Parameters:
      variableName - the string to check
      Returns:
      true if the string is a valid variable name in Java; false otherwise
    • isVariableTerm

      public static boolean isVariableTerm(String s)
      Returns true if the string is a valid variable term, meaning it begins with "[$" and ends with "$]".
      Parameters:
      s - the string to check
      Returns:
      true if the string is a valid variable term; false otherwise
    • isWhitespace

      public static boolean isWhitespace(char c)
      Returns true if the character is whitespace, meaning it is either the null character '0' or whitespace according to Character.isWhitespace(char).
      Parameters:
      c - the character to check
      Returns:
      true if the character is whitespace; false otherwise
    • isXml

      public static boolean isXml(String s)
      Returns true if the string is an XML document. The only requirement is that it contain either the xml start tag "<?xml" or the empty document tag "".
      Parameters:
      s - the string to check
      Returns:
      true if the string is an XML document; false otherwise