org.semanticweb.owlapi.util

Class OWLAPIPreconditions

java.lang.Object

org.semanticweb.owlapi.util.OWLAPIPreconditions

public final class OWLAPIPreconditions
extends Object

A set of personalized preconditions.

Method Summary

Modifier and Type	Method and Description
static void	checkIterableNotNull(Collection<?> o, String name, boolean emptyAllowed)
static void	checkIterableNotNull(Object[] o, String name, boolean emptyAllowed)
static void	checkNotNegative(long object) Check for negative value and throw IllegalArgumentException if negative.
static void	checkNotNegative(long object, String message) Check for negative value and throw IllegalArgumentException if negative.
static void	checkNotNegative(long object, Supplier<String> message) Check for negative value and throw IllegalArgumentException if negative.
static <T> T	checkNotNull(Optional<T> object, String message) Deprecated. use checkNotNull(Object, Supplier)
static <T> T	checkNotNull(Optional<T> object, Supplier<String> message) Check for absent and throw IllegalArgumentException if null or absent.
static <T> T	checkNotNull(T object) Check for null and throw NullPointerException if null.
static <T> T	checkNotNull(T object, String message) Check for null and throw NullPointerException if null.
static <T> T	checkNotNull(T object, Supplier<String> message) Check for null and throw NullPointerException if null.
static <T> Optional<T>	emptyOptional() Wrapper to allow non null annotations.
static <T> Optional<T>	emptyOptional(Class<T> t) Wrapper to allow non null annotations.
static <T> Optional<T>	optional(T t) Wrapper to allow non null annotations.
static <T> T	verifyNotNull(T object) Check that the argument is not null; if the argument is null, throw an IllegalStateException.
static <T> T	verifyNotNull(T object, String message) Check that the argument is not null; if the argument is null, throw an IllegalStateException.
static <T> T	verifyNotNull(T object, Supplier<String> message) Check that the argument is not null; if the argument is null, throw an IllegalStateException.

Methods inherited from class java.lang.Object

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

Method Detail

verifyNotNull

public static <T> T verifyNotNull(@Nullable
                                  T object)

Check that the argument is not null; if the argument is null, throw an IllegalStateException. This method is meant to be used to verify conditions on member variables rather than input parameters.

Type Parameters:

T - reference type

Parameters:

object - reference to check

Returns:

the input reference if not null

Throws:

IllegalStateException - if object is null

verifyNotNull

public static <T> T verifyNotNull(@Nullable
                                  T object,
                                  String message)

Check that the argument is not null; if the argument is null, throw an IllegalStateException. This method is meant to be used to verify conditions on member variables rather than input parameters.

Type Parameters:

T - reference type

Parameters:

object - reference to check

message - message to use for the error

Returns:

the input reference if not null

Throws:

IllegalStateException - if object is null

verifyNotNull

public static <T> T verifyNotNull(@Nullable
                                  T object,
                                  Supplier<String> message)

Check that the argument is not null; if the argument is null, throw an IllegalStateException. This method is meant to be used to verify conditions on member variables rather than input parameters.

Type Parameters:

T - reference type

Parameters:

object - reference to check

message - message to use for the error

Returns:

the input reference if not null

Throws:

IllegalStateException - if object is null

checkNotNull

public static <T> T checkNotNull(@Nullable
                                 T object)

Check for null and throw NullPointerException if null.

Type Parameters:

T - reference type

Parameters:

object - reference to check

Returns:

the input reference if not null

Throws:

NullPointerException - if object is null

checkNotNull

public static <T> T checkNotNull(@Nullable
                                 T object,
                                 String message)

Check for null and throw NullPointerException if null.

Type Parameters:

T - reference type

Parameters:

object - reference to check

message - message for the illegal argument exception

Returns:

the input reference if not null

Throws:

NullPointerException - if object is null

checkNotNull

public static <T> T checkNotNull(@Nullable
                                 T object,
                                 Supplier<String> message)

Check for null and throw NullPointerException if null.

Type Parameters:

T - reference type

Parameters:

object - reference to check

message - message for the illegal argument exception

Returns:

the input reference if not null

Throws:

NullPointerException - if object is null

checkNotNegative

public static void checkNotNegative(@Nonnegative
                                    long object)

Check for negative value and throw IllegalArgumentException if negative.

Parameters:

object - value to check

Throws:

IllegalArgumentException - if object is negative

checkNotNegative

public static void checkNotNegative(@Nonnegative
                                    long object,
                                    String message)

Check for negative value and throw IllegalArgumentException if negative.

Parameters:

object - value to check

message - message for the illegal argument exception

Throws:

IllegalArgumentException - if object is negative

checkNotNegative

public static void checkNotNegative(@Nonnegative
                                    long object,
                                    Supplier<String> message)

Check for negative value and throw IllegalArgumentException if negative.

Parameters:

object - value to check

message - message for the illegal argument exception

Throws:

IllegalArgumentException - if object is negative

checkNotNull

@Deprecated
public static <T> T checkNotNull(@Nullable
                                             Optional<T> object,
                                             String message)

Deprecated. use checkNotNull(Object, Supplier)

Check for absent and throw IllegalArgumentException if null or absent.

Type Parameters:

T - reference type

Parameters:

object - reference to check

message - message for the illegal argument exception

Returns:

the input reference if not null

Throws:

IllegalArgumentException - if object is null

checkNotNull

public static <T> T checkNotNull(@Nullable
                                 Optional<T> object,
                                 Supplier<String> message)

Check for absent and throw IllegalArgumentException if null or absent.

Type Parameters:

T - reference type

Parameters:

object - reference to check

message - message for the illegal argument exception

Returns:

the input reference if not null

Throws:

IllegalArgumentException - if object is null

checkIterableNotNull

public static void checkIterableNotNull(@Nullable
                                        Collection<?> o,
                                        String name,
                                        boolean emptyAllowed)

Parameters:

o - collection to check for nullness and null elements, and optionally for emptiness

name - message for error

emptyAllowed - true if the input can be empty

checkIterableNotNull

public static void checkIterableNotNull(Object[] o,
                                        String name,
                                        boolean emptyAllowed)

Parameters:

o - array to check for nullness and null elements, and optionally for emptiness

name - message for error

emptyAllowed - true if the input can be empty

emptyOptional

public static <T> Optional<T> emptyOptional()

Wrapper to allow non null annotations.

Returns:

empty optional instance

emptyOptional

public static <T> Optional<T> emptyOptional(Class<T> t)

Wrapper to allow non null annotations.

Parameters:

t - type for the returned optional

Returns:

empty optional instance

optional

public static <T> Optional<T> optional(@Nullable
                                       T t)

Wrapper to allow non null annotations.

Parameters:

t - instance to wrap. Can be null (the result will be Optional.empty())

Returns:

optional instance (content can be absent)