com.ardikars.common.util.Validate Maven / Gradle / Ivy
The newest version!
/**
* Copyright 2017-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.ardikars.common.util;
import com.ardikars.common.annotation.Helper;
/**
* Static convenience methods that help a method or constructor check whether it was invoked correctly.
* If validation is fail, the {@code Validate} method throws an unchecked exception
* of a specified type, which helps the method in which the exception was thrown communicate that
* its caller has made a mistake.
*
* @author Ardika Rommy Sanjaya
* @since 1.0.0
*/
@Helper
public final class Validate {
/**
* Ensures that given object ${@code reference} is not null.
* @param reference object reference.
* @param exception exceptions to be given.
* @param object reference type.
* @throws NullPointerException if {@code reference} is null.
* @since 1.0.0
*/
public static void nullPointer(T reference, NullPointerException exception)
throws NullPointerException {
if (reference == null) {
if (exception == null) {
throw new NullPointerException();
} else {
throw exception;
}
}
}
/**
* Ensures that given object ${@code reference} is not null.
* @param reference object reference.
* @param object reference type.
* @throws NullPointerException if {@code reference} is null.
* @since 1.0.0
*/
public static void nullPointer(T reference)
throws NullPointerException {
nullPointer(reference, null);
}
/**
* Ensures that given object ${@code reference} is not null.
* @param reference object reference.
* @param newVal new value.
* @param object reference and new value type.
* @return returns given ${@code newVal} if {@code reference} is null, {@code reference} otherwise.
* @since 1.0.0
*/
public static T nullPointer(T reference, T newVal) {
if (reference == null) {
return newVal;
} else {
return reference;
}
}
/**
* Ensures the truth of an expression involving one or more parameters to the calling method.
* Returns given ${@code newVal} if {@code expression} is false, {@code reference} otherwise.
* @param expression a boolean expression.
* @param reference reference.
* @param newVal new value.
* @param type of reference and new value.
* @return returns given ${@code newVal} if {@code expression} is false, {@code reference} otherwise.
* @since 1.0.0
*/
public static T notIllegalArgument(boolean expression, T reference, T newVal) {
if (!expression) {
return newVal;
} else {
return reference;
}
}
/**
* Ensures the truth of an expression involving one or more parameters to the calling method.
* @param expression a boolean expression.
* @param exception exceptions to be given
* @throws IllegalArgumentException if {@code expression} is false
* @since 1.0.0
*/
public static void notIllegalArgument(boolean expression, IllegalArgumentException exception)
throws IllegalArgumentException {
if (!expression) {
if (exception == null) {
throw new IllegalArgumentException();
} else {
throw exception;
}
}
}
/**
* Ensures the truth of an expression involving one or more parameters to the calling method.
* @param expression a boolean expression.
* @throws IllegalArgumentException if {@code expression} is false
* @since 1.0.0
*/
public static void notIllegalArgument(boolean expression)
throws IllegalArgumentException {
notIllegalArgument(expression, null);
}
/**
* Ensures that given parameter is valid bound in an array.
* @param array array.
* @param offset offset.
* @param length length.
* @throws NullPointerException if {@code array} is null.
* @throws IllegalArgumentException invalid parameters.
* @throws ArrayIndexOutOfBoundsException invalid parameters.
* @since 1.0.0
*/
public static void notInBounds(byte[] array, int offset, int length)
throws NullPointerException, IllegalArgumentException, ArrayIndexOutOfBoundsException {
nullPointer(array, new NullPointerException("array is null."));
notIllegalArgument(array.length > 0, new IllegalArgumentException("array is empty."));
notIllegalArgument(length > 0, new IllegalArgumentException("length is zero."));
if (offset < 0 || length < 0 || length > array.length || offset > array.length - 1 || offset + length > array.length) {
throw new ArrayIndexOutOfBoundsException();
}
}
/**
* Ensures that given parameter is valid bound in an array.
* @param array array.
* @param offset offset.
* @param length length.
* @throws NullPointerException if {@code array} is null.
* @throws IllegalArgumentException invalid parameters.
* @throws ArrayIndexOutOfBoundsException invalid parameters.
* @since 1.0.0
*/
public static void notInBounds(char[] array, int offset, int length)
throws NullPointerException, IllegalArgumentException, ArrayIndexOutOfBoundsException {
nullPointer(array, new NullPointerException("array is null."));
notIllegalArgument(array.length > 0, new IllegalArgumentException("array is empty."));
notIllegalArgument(length > 0, new IllegalArgumentException("length is zero."));
if (offset < 0 || length < 0 || length > array.length || offset > array.length - 1 || offset + length > array.length) {
throw new ArrayIndexOutOfBoundsException();
}
}
/**
* Ensures that given parameter is valid bound in an array.
* @param array array.
* @param offset offset.
* @param length length.
* @throws NullPointerException if {@code array} is null.
* @throws IllegalArgumentException invalid parameters.
* @throws ArrayIndexOutOfBoundsException invalid parameters.
* @since 1.0.0
*/
public static void notInBounds(short[] array, int offset, int length)
throws NullPointerException, IllegalArgumentException, ArrayIndexOutOfBoundsException {
nullPointer(array, new NullPointerException("array is null."));
notIllegalArgument(array.length > 0, new IllegalArgumentException("array is empty."));
notIllegalArgument(length > 0, new IllegalArgumentException("length is zero."));
if (offset < 0 || length < 0 || length > array.length || offset > array.length - 1 || offset + length > array.length) {
throw new ArrayIndexOutOfBoundsException();
}
}
/**
* Ensures that given parameter is valid bound in an array.
* @param array array.
* @param offset offset.
* @param length length.
* @throws NullPointerException if {@code array} is null.
* @throws IllegalArgumentException invalid parameters.
* @throws ArrayIndexOutOfBoundsException invalid parameters.
* @since 1.0.0
*/
public static void notInBounds(int[] array, int offset, int length)
throws NullPointerException, IllegalArgumentException, ArrayIndexOutOfBoundsException {
nullPointer(array, new NullPointerException("array is null."));
notIllegalArgument(array.length > 0, new IllegalArgumentException("array is empty."));
notIllegalArgument(length > 0, new IllegalArgumentException("length is zero."));
if (offset < 0 || length < 0 || length > array.length || offset > array.length - 1 || offset + length > array.length) {
throw new ArrayIndexOutOfBoundsException();
}
}
/**
* Ensures that given parameter is valid bound in an array.
* @param array array.
* @param offset offset.
* @param length length.
* @throws NullPointerException if {@code array} is null.
* @throws IllegalArgumentException invalid parameters.
* @throws ArrayIndexOutOfBoundsException invalid parameters.
* @since 1.0.0
*/
public static void notInBounds(float[] array, int offset, int length)
throws NullPointerException, IllegalArgumentException, ArrayIndexOutOfBoundsException {
nullPointer(array, new NullPointerException("array is null."));
notIllegalArgument(array.length > 0, new IllegalArgumentException("array is empty."));
notIllegalArgument(length > 0, new IllegalArgumentException("length is zero."));
if (offset < 0 || length < 0 || length > array.length || offset > array.length - 1 || offset + length > array.length) {
throw new ArrayIndexOutOfBoundsException();
}
}
/**
* Ensures that given parameter is valid bound in an array.
* @param array array.
* @param offset offset.
* @param length length.
* @throws NullPointerException if {@code array} is null.
* @throws IllegalArgumentException invalid parameters.
* @throws ArrayIndexOutOfBoundsException invalid parameters.
* @since 1.0.0
*/
public static void notInBounds(long[] array, int offset, int length)
throws NullPointerException, IllegalArgumentException, ArrayIndexOutOfBoundsException {
nullPointer(array, new NullPointerException("array is null."));
notIllegalArgument(array.length > 0, new IllegalArgumentException("array is empty."));
notIllegalArgument(length > 0, new IllegalArgumentException("length is zero."));
if (offset < 0 || length < 0 || length > array.length || offset > array.length - 1 || offset + length > array.length) {
throw new ArrayIndexOutOfBoundsException();
}
}
/**
* Ensures that given parameter is valid bound in an array.
* @param array array.
* @param offset offset.
* @param length length.
* @throws NullPointerException if {@code array} is null.
* @throws IllegalArgumentException invalid parameters.
* @throws ArrayIndexOutOfBoundsException invalid parameters.
* @since 1.0.0
*/
public static void notInBounds(double[] array, int offset, int length)
throws NullPointerException, IllegalArgumentException, ArrayIndexOutOfBoundsException {
nullPointer(array, new NullPointerException("array is null."));
notIllegalArgument(array.length > 0, new IllegalArgumentException("array is empty."));
notIllegalArgument(length > 0, new IllegalArgumentException("length is zero."));
if (offset < 0 || length < 0 || length > array.length || offset > array.length - 1 || offset + length > array.length) {
throw new ArrayIndexOutOfBoundsException();
}
}
/**
* Ensures that given parameter is valid bound in an array.
* @param array array.
* @param offset offset.
* @param length length.
* @param array type.
* @throws NullPointerException if {@code array} is null.
* @throws IllegalArgumentException invalid parameters.
* @throws ArrayIndexOutOfBoundsException invalid parameters.
* @since 1.0.0
*/
public static void notInBounds(T[] array, int offset, int length)
throws NullPointerException, IllegalArgumentException, ArrayIndexOutOfBoundsException {
nullPointer(array, new NullPointerException("array is null."));
notIllegalArgument(array.length > 0, new IllegalArgumentException("array is empty."));
notIllegalArgument(length > 0, new IllegalArgumentException("length is zero."));
if (offset < 0 || length < 0 || length > array.length || offset > array.length - 1 || offset + length > array.length) {
throw new ArrayIndexOutOfBoundsException();
}
}
/**
* Ensures that given parameter is valid bound.
* @param size size.
* @param offset offset.
* @param length length.
* @throws IllegalArgumentException illegal argement exception.
* @since 1.1.0
*/
public static void notInBounds(int size, int offset, int length) throws IllegalArgumentException {
notIllegalArgument(size > 0, new IllegalArgumentException("size should be greater then zero."));
notIllegalArgument(length > 0, new IllegalArgumentException("length is zero."));
if (offset < 0 || length < 0 || length > size || offset > size - 1 || offset + length > size) {
throw new ArrayIndexOutOfBoundsException();
}
}
/**
* Ensures that given parameter is not contains non numeric character.
* @param text test.
* @throws IllegalArgumentException illegal argument exception.
*/
@Deprecated
public static void notNumeric(String text) throws IllegalArgumentException {
notIllegalArgument(text != null, new IllegalArgumentException("Text should be not null."));
notIllegalArgument(text.length() > 0, new IllegalArgumentException("Text should be not empty."));
int length = text.length();
for (int i = 0; i < length; i++) {
if (!Character.isDigit(text.charAt(i))) {
throw new IllegalArgumentException("Text should not contains non numeric character.");
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy