Module overrungl.core

Package overrungl.util

Class CheckUtil

java.lang.Object

overrungl.util.CheckUtil

public final class CheckUtil
extends Object

CheckUtil relies on preview features of the Java platform:

• CheckUtil refers to one or more preview APIs: MemorySegment.

Programs can only use CheckUtil when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

The check utilities.

Since:

0.1.0

Author:

squid233

Method Summary

Modifier and Type	Method	Description
static void	check(boolean condition)	Checks whether the given condition is true.
static void	check(boolean condition, String message)	Checks whether the given condition is true.
static void	check(boolean condition, Supplier<String> messageSupplier)	Checks whether the given condition is true.
static void	checkNotNull(Object o)	Checks whether the given object is not null.
static void	checkNotNull(Object o, String message)	Checks whether the given object is not null.
static void	checkNotNull(Object o, Supplier<String> messageSupplier)	Checks whether the given object is not null.
static void	checkNotNullptr(MemorySegmentPREVIEW segment)	Checks whether the given segment is not NULL.
static void	checkNotNullptr(MemorySegmentPREVIEW segment, String message)	Checks whether the given segment is not NULL.
static void	checkNotNullptr(MemorySegmentPREVIEW segment, Supplier<String> messageSupplier)	Checks whether the given segment is not NULL.

Methods inherited from class java.lang.Object

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

Method Details

check

public static void check(boolean condition)
                  throws IllegalStateException

Checks whether the given condition is true.

Parameters:

condition - the condition.

Throws:

IllegalStateException - if condition is false.

See Also:

• check(boolean, Supplier)
• check(boolean, String)

check

public static void check(boolean condition,
 Supplier<String> messageSupplier)
                  throws IllegalStateException

Checks whether the given condition is true. The message of the exception is wrapped in a supplier to avoid side effect.

Parameters:

condition - the condition.

messageSupplier - the message supplier of the exception.

Throws:

IllegalStateException - if condition is false.

See Also:

• check(boolean)
• check(boolean, String)

check

public static void check(boolean condition,
 String message)
                  throws IllegalStateException

Checks whether the given condition is true.

Parameters:

condition - the condition.

message - the message of the exception.

Throws:

IllegalStateException - if condition is false.

See Also:

• check(boolean)
• check(boolean, Supplier)

checkNotNullptr

public static void checkNotNullptr(MemorySegmentPREVIEW segment)
                            throws IllegalStateException

Checks whether the given segment is not NULL.

Parameters:

segment - the segment.

Throws:

IllegalStateException - if segment is NULL.

See Also:

• checkNotNullptr(MemorySegment, Supplier)^PREVIEW
• checkNotNullptr(MemorySegment, String)^PREVIEW

checkNotNullptr

public static void checkNotNullptr(MemorySegmentPREVIEW segment,
 Supplier<String> messageSupplier)
                            throws IllegalStateException

Checks whether the given segment is not NULL. The message of the exception is wrapped in a supplier to avoid side effect.

Parameters:

segment - the segment.

messageSupplier - the message supplier of the exception.

Throws:

IllegalStateException - if segment is NULL.

See Also:

• checkNotNullptr(MemorySegment)^PREVIEW
• checkNotNullptr(MemorySegment, String)^PREVIEW

checkNotNullptr

public static void checkNotNullptr(MemorySegmentPREVIEW segment,
 String message)
                            throws IllegalStateException

Checks whether the given segment is not NULL.

Parameters:

segment - the segment.

message - the message of the exception.

Throws:

IllegalStateException - if segment is NULL.

See Also:

• checkNotNullptr(MemorySegment)^PREVIEW
• checkNotNullptr(MemorySegment, Supplier)^PREVIEW

checkNotNull

public static void checkNotNull(Object o)
                         throws IllegalStateException

Checks whether the given object is not null.

Parameters:

o - the object.

Throws:

IllegalStateException - if object is null.

See Also:

• checkNotNull(Object, Supplier)
• checkNotNull(Object, String)

checkNotNull

public static void checkNotNull(Object o,
 Supplier<String> messageSupplier)
                         throws IllegalStateException

Checks whether the given object is not null. The message of the exception is wrapped in a supplier to avoid side effect.

Parameters:

o - the object.

messageSupplier - the message supplier of the exception.

Throws:

IllegalStateException - if object is null.

See Also:

• checkNotNull(Object)
• checkNotNull(Object, String)

checkNotNull

public static void checkNotNull(Object o,
 String message)
                         throws IllegalStateException

Checks whether the given object is not null.

Parameters:

o - the object.

message - the message of the exception.

Throws:

IllegalStateException - if object is null.

See Also:

• checkNotNull(Object)
• checkNotNull(Object, Supplier)