/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* 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 org.jboss.shrinkwrap.resolver.impl.maven.util;
import java.io.File;
import java.util.Collection;
Validate
Validation utility
Author: Aslak Knutsen, Karel Piwko
/**
* Validate
*
* Validation utility
*
* @author <a href="mailto:aslak@conduct.no">Aslak Knutsen</a>
* @author <a href="mailto:kpiwko@redhat.com">Karel Piwko</a>
*/
public final class Validate {
private Validate() {
}
Checks that object is not null, throws exception if it is.
Params: - obj –
The object to check
- message –
The exception message
Throws: - IllegalArgumentException –
Thrown if obj is null
/**
* Checks that object is not null, throws exception if it is.
*
* @param obj
* The object to check
* @param message
* The exception message
* @throws IllegalArgumentException
* Thrown if obj is null
*/
public static void notNull(final Object obj, final String message) throws IllegalArgumentException {
if (obj == null) {
throw new IllegalArgumentException(message);
}
}
Checks that object is not null, throws exception if it is.
Params: - obj –
The object to check
- message –
The exception message
Throws: - IllegalStateException –
Thrown if obj is null
/**
* Checks that object is not null, throws exception if it is.
*
* @param obj
* The object to check
* @param message
* The exception message
* @throws IllegalStateException
* Thrown if obj is null
*/
public static void stateNotNull(final Object obj, final String message) throws IllegalStateException {
if (obj == null) {
throw new IllegalStateException(message);
}
}
Checks that collection is not null
or empty, throws exception if it is. Params: - collection –
The collection to be checked
- message –
The exception message
Throws: - IllegalArgumentException – Thrown if
collection
is null
or empty
/**
* Checks that collection is not {@code null} or empty, throws exception if it is.
*
* @param collection
* The collection to be checked
* @param message
* The exception message
* @throws IllegalArgumentException
* Thrown if {@code collection} is {@code null} or empty
*/
public static void notEmpty(final Collection<?> collection, final String message) throws IllegalArgumentException {
if (collection == null || collection.size() == 0) {
throw new IllegalArgumentException(message);
}
}
Checks that the specified String is not null or empty.
Params: - string –
The object to check
Returns: true
if specified String is null or empty, false
otherwise
/**
* Checks that the specified String is not null or empty.
*
* @param string
* The object to check
* @return {@code true} if specified String is null or empty, {@code false} otherwise
*/
public static boolean isNullOrEmpty(final String string) {
if (string == null || string.length() == 0) {
return true;
}
return false;
}
Checks that the specified String is not null or empty or question mark "?".
Params: - string –
The object to check
Returns: true
if specified String is null or empty, false
otherwise
/**
* Checks that the specified String is not null or empty or question mark "?".
*
* @param string
* The object to check
* @return {@code true} if specified String is null or empty, {@code false} otherwise
*/
public static boolean isNullOrEmptyOrQuestionMark(final String string) {
if (string == null || string.length() == 0 || "?".equals(string)) {
return true;
}
return false;
}
Checks that the specified String is not null or empty, throws exception if it is.
Params: - string –
The object to check
- message –
The exception message
Throws: - IllegalArgumentException –
Thrown if string is null
/**
* Checks that the specified String is not null or empty, throws exception if it is.
*
* @param string
* The object to check
* @param message
* The exception message
* @throws IllegalArgumentException
* Thrown if string is null
*/
public static void notNullOrEmpty(final String string, final String message) throws IllegalArgumentException {
if (string == null || string.length() == 0) {
throw new IllegalArgumentException(message);
}
}
Checks that the specified String is not null or empty and represents a readable file, throws exception if it is
empty or null and does not represent a path to a file.
Params: - path –
The path to check
- message –
The exception message
Throws: - IllegalArgumentException –
Thrown if path is empty, null or invalid
/**
* Checks that the specified String is not null or empty and represents a readable file, throws exception if it is
* empty or null and does not represent a path to a file.
*
* @param path
* The path to check
* @param message
* The exception message
* @throws IllegalArgumentException
* Thrown if path is empty, null or invalid
*/
public static void readable(final String path, final String message) throws IllegalArgumentException {
notNullOrEmpty(path, message);
readable(new File(path), message);
}
Checks that the specified String is not null or empty and represents a readable file, throws exception if it is
empty or null and does not represent a path to a file.
Params: - path –
The path to check
- message –
The exception message
Throws: - IllegalArgumentException –
Thrown if path is empty, null or invalid
/**
* Checks that the specified String is not null or empty and represents a readable file, throws exception if it is
* empty or null and does not represent a path to a file.
*
* @param path
* The path to check
* @param message
* The exception message
* @throws IllegalArgumentException
* Thrown if path is empty, null or invalid
*/
public static void readable(final File path, final String message) throws IllegalArgumentException {
notNull(path, message);
if (!isReadable(path)) {
throw new IllegalArgumentException(message);
}
}
public static boolean isReadable(final File path) {
return (path != null) && path.exists() && path.canRead();
}
Checks that the specified String is not null or empty and represents a writeable directory, throws exception if
it is empty or null and does not represent a path to a directory.
Params: - path –
The path to check
- message –
The exception message
Throws: - IllegalArgumentException –
Thrown if path is empty, null or invalid
/**
* Checks that the specified String is not null or empty and represents a writeable directory, throws exception if
* it is empty or null and does not represent a path to a directory.
*
* @param path
* The path to check
* @param message
* The exception message
* @throws IllegalArgumentException
* Thrown if path is empty, null or invalid
*/
public static void writeableDirectory(final String path, String message) throws IllegalArgumentException {
notNullOrEmpty(path, message);
File file = new File(path);
if (!file.exists() || !file.isDirectory() || !file.canWrite() || !file.canExecute()) {
throw new IllegalArgumentException(message);
}
}
Checks that the specified array is not null or contain any null values.
Params: - objects –
The object to check
- message –
The exception message
/**
* Checks that the specified array is not null or contain any null values.
*
* @param objects
* The object to check
* @param message
* The exception message
*/
public static void notNullAndNoNullValues(final Object[] objects, final String message) {
notNull(objects, message);
for (Object object : objects) {
notNull(object, message);
}
}
Checks that the specified File
is not null, exists and represents a readable file, throws exception if it is empty or null and does not represent a path to a file. Params: - file – The
File
to check - message –
The exception message
Throws: - IllegalArgumentException –
Thrown if path is empty, null or invalid
/**
* Checks that the specified {@link File} is not null, exists and represents a readable file, throws exception if it is
* empty or null and does not represent a path to a file.
*
* @param file
* The {@link File} to check
* @param message
* The exception message
* @throws IllegalArgumentException
* Thrown if path is empty, null or invalid
*/
public static void isReadable(final File file, String message) throws IllegalArgumentException {
notNull(file, message);
if (!file.exists() || !file.isFile() || !file.canRead()) {
throw new IllegalArgumentException(message);
}
}
Checks that the specified String is not null or empty and represents a readable file, throws exception if it is
empty or null and does not represent a path to a file.
Params: - path –
The path to check
- message –
The exception message
Throws: - IllegalArgumentException –
Thrown if path is empty, null or invalid
/**
* Checks that the specified String is not null or empty and represents a readable file, throws exception if it is
* empty or null and does not represent a path to a file.
*
* @param path
* The path to check
* @param message
* The exception message
* @throws IllegalArgumentException
* Thrown if path is empty, null or invalid
*/
public static void isReadable(final String path, String message) throws IllegalArgumentException {
notNullOrEmpty(path, message);
isReadable(new File(path), message);
}
}