org.iherus.shiro.util

类 Utils

java.lang.Object

org.iherus.shiro.util.Utils

public abstract class Utils
extends Object

工具类

从以下版本开始:

2.0.0

作者:

Bosco.Liao

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	Utils.MutableArray<T>

构造器概要

构造器

构造器和说明
Utils()

方法概要

限定符和类型	方法和说明
static void	assertIsTrue(boolean expression, Supplier<String> messageSupplier) Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.
static void	assertNotBlank(String text, String message) Assert that the given String contains valid text content; that is, it must not be null and must contain at least one non-whitespace character.
static void	assertNotNull(Object object, String message) Assert whether the object is null.
static String	bytesToText(byte[] bytes) Byte[] about
static byte[]	clone(byte[] array) Clones an array returning a typecast result and handling null.
static Set<String>	commaDelimitedListToSet(String str) Convert a comma delimited list (e.g., a row from a CSV file) into a set.
static String[]	commaDelimitedListToStringArray(String str) Convert a comma delimited list (e.g., a row from a CSV file) into an array of strings.
static String	deleteAny(String inString, String charsToDelete) Delete any character in a given String.
static String[]	delimitedListToStringArray(String str, String delimiter) Take a String that is a delimited list and convert it into a String array.
static String[]	delimitedListToStringArray(String str, String delimiter, String charsToDelete) Take a String that is a delimited list and convert it into a String array.
static Field	findField(Class<?> clazz, String name) Attempt to find a field on the supplied Class with the supplied name.
static Field	findField(Class<?> clazz, String name, Class<?> type) Attempt to find a field on the supplied Class with the supplied name and/or type.
static Method	findMethod(Class<?> clazz, String name) Attempt to find a Method on the supplied class with the supplied name and no parameters.
static Method	findMethod(Class<?> clazz, String name, Class<?>... argTypes) Attempt to find a Method on the supplied class with the supplied name and parameter types.
static <T> T	getFieldValue(Object target, String name, Class<T> type) Get the field represented by the supplied field object on the specified target object.
static boolean	hasLength(String str) Check that the given String is neither null nor of length 0.
static byte[]	intToBytes(int number) numeric long to byte array.
static Object	invokeMethod(Object target, String methodName)
static Object	invokeMethod(Object target, String methodName, Class<?>[] argTypes, Object... args)
static Object	invokeMethod(Object target, String methodName, Class<?> argType, Object arg)
static boolean	isBlank(CharSequence cs) Whether the CharSequence is blank.
static boolean	isEmpty(byte[] array) Whether the byte array is empty.
static boolean	isEmpty(byte[][] array) Whether the byte[] array is empty.
static boolean	isEmpty(CharSequence cs) Whether the CharSequence is empty.
static boolean	isEmpty(Collection<?> collection) Return true if the supplied Collection is null or empty.
static boolean	isNotBlank(CharSequence cs) Whether the CharSequence is not blank.
static boolean	isNotEmpty(CharSequence cs) Whether the CharSequence is not empty.
static byte[]	longToBytes(long number)
static void	makeAccessible(Field field) Make the given field accessible, explicitly setting it accessible if necessary.
static void	makeAccessible(Method method)
static byte[]	mergeAll(byte[] array1, byte... array2) Merges all the elements of the given arrays into a new array.
static <T> Utils.MutableArray<T>	newMutableArray(T... elements)
static boolean	nullSafeEquals(Object o1, Object o2) Determine if the given objects are equal, returning true if both are null or false if only one is null.
static int	nullSafeHashCode(boolean[] array) Return a hash code based on the contents of the specified array.
static int	nullSafeHashCode(byte[] array) Return a hash code based on the contents of the specified array.
static int	nullSafeHashCode(char[] array) Return a hash code based on the contents of the specified array.
static int	nullSafeHashCode(double[] array) Return a hash code based on the contents of the specified array.
static int	nullSafeHashCode(float[] array) Return a hash code based on the contents of the specified array.
static int	nullSafeHashCode(int[] array) Return a hash code based on the contents of the specified array.
static int	nullSafeHashCode(long[] array) Return a hash code based on the contents of the specified array.
static int	nullSafeHashCode(Object obj) Return as hash code for the given object; typically the value of Object#hashCode()}.
static int	nullSafeHashCode(Object[] array) Return a hash code based on the contents of the specified array.
static int	nullSafeHashCode(short[] array) Return a hash code based on the contents of the specified array.
static <T> void	setFieldValue(Object target, String name, Class<T> type, Object value)
static String[]	split(String toSplit, String delimiter) Split a String at the first occurrence of the delimiter.
static byte[]	subarray(byte[] array, int startIndexInclusive, int endIndexExclusive) Produces a new byte array containing the elements between the start and end indices.
static String[]	toStringArray(Collection<String> collection) Copy the given Collection into a String array.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Utils

public Utils()

方法详细资料

newMutableArray

public static <T> Utils.MutableArray<T> newMutableArray(T... elements)

assertNotBlank

public static void assertNotBlank(String text,
                                  String message)

Assert that the given String contains valid text content; that is, it must not be null and must contain at least one non-whitespace character.

Utils.assertNotBlank(name, "'name' must not be empty");

assertNotNull

public static void assertNotNull(Object object,
                                 String message)

Assert whether the object is null.

assertIsTrue

public static void assertIsTrue(boolean expression,
                                Supplier<String> messageSupplier)

Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.

 Utils.assertIsTrue(i > 0, () -> "The value '" + i + "' must be greater than zero");
 

isEmpty

public static boolean isEmpty(CharSequence cs)

Whether the CharSequence is empty.

isNotEmpty

public static boolean isNotEmpty(CharSequence cs)

Whether the CharSequence is not empty.

isBlank

public static boolean isBlank(CharSequence cs)

Whether the CharSequence is blank.

isNotBlank

public static boolean isNotBlank(CharSequence cs)

Whether the CharSequence is not blank.

split

public static String[] split(String toSplit,
                             String delimiter)

Split a String at the first occurrence of the delimiter. Does not include the delimiter in the result.

参数:

toSplit - the string to split (potentially null or empty)

delimiter - to split the string up with (potentially null or empty)

返回:

a two element array with index 0 being before the delimiter, and index 1 being after the delimiter (neither element includes the delimiter); or null if the delimiter wasn't found in the given input String

commaDelimitedListToSet

public static Set<String> commaDelimitedListToSet(String str)

Convert a comma delimited list (e.g., a row from a CSV file) into a set.

Note that this will suppress duplicates, and as of 4.2, the elements in the returned set will preserve the original order in a LinkedHashSet.

参数:

str - the input String (potentially null or empty)

返回:

a set of String entries in the list

另请参阅:

#removeDuplicateStrings(String[])

commaDelimitedListToStringArray

public static String[] commaDelimitedListToStringArray(String str)

Convert a comma delimited list (e.g., a row from a CSV file) into an array of strings.

参数:

str - the input String (potentially null or empty)

返回:

an array of strings, or the empty array in case of empty input

delimitedListToStringArray

public static String[] delimitedListToStringArray(String str,
                                                  String delimiter)

Take a String that is a delimited list and convert it into a String array.

A single delimiter may consist of more than one character, but it will still be considered as a single delimiter string, rather than as bunch of potential delimiter characters, in contrast to #tokenizeToStringArray.

参数:

str - the input String (potentially null or empty)

delimiter - the delimiter between elements (this is a single delimiter, rather than a bunch individual delimiter characters)

返回:

an array of the tokens in the list

另请参阅:

#tokenizeToStringArray

delimitedListToStringArray

public static String[] delimitedListToStringArray(String str,
                                                  String delimiter,
                                                  String charsToDelete)

Take a String that is a delimited list and convert it into a String array.

A single delimiter may consist of more than one character, but it will still be considered as a single delimiter string, rather than as bunch of potential delimiter characters, in contrast to #tokenizeToStringArray.

参数:

str - the input String (potentially null or empty)

delimiter - the delimiter between elements (this is a single delimiter, rather than a bunch individual delimiter characters)

charsToDelete - a set of characters to delete; useful for deleting unwanted line breaks: e.g. "\r\n\f" will delete all new lines and line feeds in a String

返回:

an array of the tokens in the list

另请参阅:

#tokenizeToStringArray

toStringArray

public static String[] toStringArray(Collection<String> collection)

Copy the given Collection into a String array.

The Collection must contain String elements only.

参数:

collection - the Collection to copy (potentially null or empty)

返回:

the resulting String array

isEmpty

public static boolean isEmpty(Collection<?> collection)

Return true if the supplied Collection is null or empty. Otherwise, return false.

参数:

collection - the Collection to check

返回:

whether the given Collection is empty

deleteAny

public static String deleteAny(String inString,
                               String charsToDelete)

Delete any character in a given String.

参数:

inString - the original String

charsToDelete - a set of characters to delete. E.g. "az\n" will delete 'a's, 'z's and new lines.

返回:

the resulting String

hasLength

public static boolean hasLength(String str)

Check that the given String is neither null nor of length 0.

Note: this method returns true for a String that purely consists of whitespace.

参数:

str - the String to check (may be null)

返回:

true if the String is not null and has length

另请参阅:

#hasLength(CharSequence), #hasText(String)

bytesToText

public static String bytesToText(byte[] bytes)

Byte[] about

intToBytes

public static byte[] intToBytes(int number)

numeric long to byte array.

longToBytes

public static byte[] longToBytes(long number)

clone

public static byte[] clone(byte[] array)

Clones an array returning a typecast result and handling null.

isEmpty

public static boolean isEmpty(byte[] array)

Whether the byte array is empty.

isEmpty

public static boolean isEmpty(byte[][] array)

Whether the byte[] array is empty.

mergeAll

public static byte[] mergeAll(byte[] array1,
                              byte... array2)

Merges all the elements of the given arrays into a new array.

subarray

public static byte[] subarray(byte[] array,
                              int startIndexInclusive,
                              int endIndexExclusive)

Produces a new byte array containing the elements between the start and end indices.

nullSafeHashCode

public static int nullSafeHashCode(Object obj)

Return as hash code for the given object; typically the value of Object#hashCode()}. If the object is an array, this method will delegate to any of the nullSafeHashCode methods for arrays in this class. If the object is null, this method returns 0.

另请参阅:

Object.hashCode(), nullSafeHashCode(Object[]), nullSafeHashCode(boolean[]), nullSafeHashCode(byte[]), nullSafeHashCode(char[]), nullSafeHashCode(double[]), nullSafeHashCode(float[]), nullSafeHashCode(int[]), nullSafeHashCode(long[]), nullSafeHashCode(short[])

nullSafeHashCode

public static int nullSafeHashCode(Object[] array)

Return a hash code based on the contents of the specified array. If array is null, this method returns 0.

nullSafeHashCode

public static int nullSafeHashCode(boolean[] array)

Return a hash code based on the contents of the specified array. If array is null, this method returns 0.

nullSafeHashCode

public static int nullSafeHashCode(byte[] array)

Return a hash code based on the contents of the specified array. If array is null, this method returns 0.

nullSafeHashCode

public static int nullSafeHashCode(char[] array)

Return a hash code based on the contents of the specified array. If array is null, this method returns 0.

nullSafeHashCode

public static int nullSafeHashCode(double[] array)

Return a hash code based on the contents of the specified array. If array is null, this method returns 0.

nullSafeHashCode

public static int nullSafeHashCode(float[] array)

Return a hash code based on the contents of the specified array. If array is null, this method returns 0.

nullSafeHashCode

public static int nullSafeHashCode(int[] array)

Return a hash code based on the contents of the specified array. If array is null, this method returns 0.

nullSafeHashCode

public static int nullSafeHashCode(long[] array)

Return a hash code based on the contents of the specified array. If array is null, this method returns 0.

nullSafeHashCode

public static int nullSafeHashCode(short[] array)

Return a hash code based on the contents of the specified array. If array is null, this method returns 0.

nullSafeEquals

public static boolean nullSafeEquals(Object o1,
                                     Object o2)

Determine if the given objects are equal, returning true if both are null or false if only one is null.

Compares arrays with Arrays.equals, performing an equality check based on the array elements rather than the array reference.

参数:

o1 - first Object to compare

o2 - second Object to compare

返回:

whether the given objects are equal

另请参阅:

Object.equals(Object), Arrays.equals(long[], long[])

findField

public static Field findField(Class<?> clazz,
                              String name)

Attempt to find a field on the supplied Class with the supplied name. Searches all super-classes up to Object.

参数:

clazz - the class to introspect

name - the name of the field

返回:

the corresponding Field object, or null if not found

getFieldValue

public static <T> T getFieldValue(Object target,
                                  String name,
                                  Class<T> type)

Get the field represented by the supplied field object on the specified target object. In accordance with Field.get(Object) semantics, the returned value is automatically wrapped if the underlying field has a primitive type.

类型参数:

T -

参数:

name - the field name to get

target - the target object from which to get the field

返回:

the field's current value

setFieldValue

public static <T> void setFieldValue(Object target,
                                     String name,
                                     Class<T> type,
                                     Object value)

makeAccessible

public static void makeAccessible(Field field)

Make the given field accessible, explicitly setting it accessible if necessary. The setAccessible(true) method is only called when actually necessary, to avoid unnecessary conflicts with a JVM SecurityManager (if active).

参数:

field - the field to make accessible

另请参阅:

AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)

findField

public static Field findField(Class<?> clazz,
                              String name,
                              Class<?> type)

Attempt to find a field on the supplied Class with the supplied name and/or type. Searches all super-classes up to Object.

参数:

clazz - the class to introspect

name - the name of the field (may be null if type is specified)

type - the type of the field (may be null if name is specified)

返回:

the corresponding Field object, or null if not found

findMethod

public static Method findMethod(Class<?> clazz,
                                String name)

Attempt to find a Method on the supplied class with the supplied name and no parameters. Searches all superclasses up to Object.

Returns null if no Method can be found.

参数:

clazz - the class to introspect

name - the name of the method

返回:

the Method object, or null if none found

findMethod

public static Method findMethod(Class<?> clazz,
                                String name,
                                Class<?>... argTypes)

Attempt to find a Method on the supplied class with the supplied name and parameter types. Searches all superclasses up to Object.

Returns null if no Method can be found.

参数:

clazz - the class to introspect

name - the name of the method

paramTypes - the parameter types of the method (may be null to indicate any signature)

返回:

the Method object, or null if none found

makeAccessible

public static void makeAccessible(Method method)

invokeMethod

public static Object invokeMethod(Object target,
                                  String methodName)

invokeMethod

public static Object invokeMethod(Object target,
                                  String methodName,
                                  Class<?> argType,
                                  Object arg)

invokeMethod

public static Object invokeMethod(Object target,
                                  String methodName,
                                  Class<?>[] argTypes,
                                  Object... args)