org.apache.river.api.io

Class Valid

java.lang.Object

org.apache.river.api.io.Valid

public class Valid
extends Object

Utilities for validating invariants.

Author:

peter

Constructor Summary

Constructors

Constructor and Description
Valid()

Method Summary

Modifier and Type	Method and Description
static boolean[]	copy(boolean[] arry)
static byte[]	copy(byte[] arry)
static char[]	copy(char[] arry)
static double[]	copy(double[] arry)
static float[]	copy(float[] arry)
static int[]	copy(int[] arry)
static long[]	copy(long[] arry)
static short[]	copy(short[] arry)
static <T> T	copy(T obj) Convenience method to copy Cloneable objects.
static <T> T[]	copy(T[] arry) Convenience method to create a shallow copy of an array if non null.
static <T extends Collection<E>,E> T	copyCol(T source, T destination, Class<E> type) Convenience method to copy and type check all elements from the source collection, into the destination collection.
static <T extends Map<K,V>,K,V> T	copyMap(T source, T destination, Class<K> key, Class<V> val) Convenience method to copy and type check all keys and values from the source map, into the destination map.
static <T> T[]	deepCopy(T[] arry) Convenience method to perform a deep copy of an array containing Cloneable objects
static <T> T	hasClass(Class<T> type, Object o)
static <T> T	isInstance(Class<T> type, Object o)
static <T> T	notNull(T obj, String message) Convenience method to check that an object is non null.
static <T> T[]	nullElement(T[] arry, String message) Checks all elements in an array for null values, if the arry parameter is not null.

Methods inherited from class java.lang.Object

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

Constructor Detail

Valid

public Valid()

Method Detail

isInstance

public static <T> T isInstance(Class<T> type,
                               Object o)
                        throws InvalidObjectException

Throws:

InvalidObjectException

hasClass

public static <T> T hasClass(Class<T> type,
                             Object o)
                      throws InvalidObjectException

Throws:

InvalidObjectException

copyCol

public static <T extends Collection<E>,E> T copyCol(T source,
                                                    T destination,
                                                    Class<E> type)

Convenience method to copy and type check all elements from the source collection, into the destination collection. Instances of java.util.Collection will be replaced in the stream by a safe limited functionality immutable Collection instance that must be replaced during deserialization.

Type Parameters:

T - Collection or subtype.

E - Element type.

Parameters:

source - Collection containing unchecked elements.

destination - Empty Collection to populate with checked elements.

type -

Returns:

the populated destination collection.

Throws:

ClassCastException

NullPointerException - if any parameter is null.

notNull

public static <T> T notNull(T obj,
                            String message)
                     throws InvalidObjectException

Convenience method to check that an object is non null.

Type Parameters:

T -

Parameters:

obj -

message - reason for exception.

Returns:

obj if non null.

Throws:

InvalidObjectException - with a NullPointerException as its cause.

nullElement

public static <T> T[] nullElement(T[] arry,
                                  String message)
                           throws InvalidObjectException

Checks all elements in an array for null values, if the arry parameter is not null.

Type Parameters:

T -

Parameters:

arry - the array

message - the message for the InvalidObjectException

Returns:

the array or null if arry is null.

Throws:

InvalidObjectException - if array contains null elements.

deepCopy

public static <T> T[] deepCopy(T[] arry)
                        throws CloneNotSupportedException

Convenience method to perform a deep copy of an array containing Cloneable objects

Type Parameters:

T -

Parameters:

arry - - may be null or contain null elements.

Returns:

A deep clone of arry, or null if arry is null.

Throws:

CloneNotSupportedException

copy

public static <T> T[] copy(T[] arry)

Convenience method to create a shallow copy of an array if non null. Since arrays are mutable, an attacker can retain a reference to a de-serialized array, that allows an attacker to mutate that array.

Type Parameters:

T - type

Parameters:

arry - that will be cloned.

Returns:

A clone of arry, or null if arry is null.

copy

public static byte[] copy(byte[] arry)

copy

public static boolean[] copy(boolean[] arry)

copy

public static char[] copy(char[] arry)

copy

public static short[] copy(short[] arry)

copy

public static int[] copy(int[] arry)

copy

public static long[] copy(long[] arry)

copy

public static double[] copy(double[] arry)

copy

public static float[] copy(float[] arry)

copy

public static <T> T copy(T obj)
                  throws CloneNotSupportedException

Convenience method to copy Cloneable objects.

Type Parameters:

T -

Parameters:

obj -

Returns:

a clone of obj if non null, otherwise null;

Throws:

CloneNotSupportedException

copyMap

public static <T extends Map<K,V>,K,V> T copyMap(T source,
                                                 T destination,
                                                 Class<K> key,
                                                 Class<V> val)

Convenience method to copy and type check all keys and values from the source map, into the destination map.

Type Parameters:

T - Map or subtype.

K - key type.

V - value type.

Parameters:

source - any map containing unchecked keys and values.

destination - a map into which checked values and keys are to be copied.

key - Class of key to type check.

val - Class of value to type check.

Returns:

the populated destination map.

Throws:

ClassCastException

NullPointerException - if any parameter is null.