Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni.template

Class Result<T extends ConstJoltPhysicsObject>

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.template.Result<T>

Type Parameters:

T - the const datatype produced when successful

All Implemented Interfaces:

ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

Direct Known Subclasses:

BcsResult, ConstraintResult, GroupFilterResult, PathResult, PhysicsMaterialResult, PhysicsSceneResult, RagdollResult, SbcsResult, SettingsResult, ShapeResult

public abstract class Result<T extends ConstJoltPhysicsObject>
extends JoltPhysicsObject

The result of an operation that might fail.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Result()	Instantiate with no native object assigned.

Method Summary

Modifier and Type	Method	Description
abstract T	get()	Return the result of a successful operation.
String	getError()	Return the error message.
protected abstract String	getError(long resultVa)	Return the error message.
boolean	hasError()	Test whether an error occurred.
protected abstract boolean	hasError(long resultVa)	Test whether an error occurred.
boolean	isValid()	Test whether the value returned by get() is valid.
protected abstract boolean	isValid(long resultVa)	Test whether the value returned by get() is valid.

Methods inherited from class com.github.stephengold.joltjni.JoltPhysicsObject

close, compareTo, equals, getContainingObject, hasAssignedNativeObject, hashCode, isCleanerStarted, ownsNativeObject, setVirtualAddress, setVirtualAddress, startCleaner, targetVa, toString, va

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Result

protected Result()

Instantiate with no native object assigned.

This no-arg constructor was made explicit to avoid javadoc warnings from JDK 18+.

Method Details

get

public abstract T get()

Return the result of a successful operation.

Returns:

a new JVM object with the pre-existing native object assigned

getError

public String getError()

Return the error message.

Returns:

a string of text

hasError

public boolean hasError()

Test whether an error occurred.

Returns:

true if error, otherwise false

isValid

public boolean isValid()

Test whether the value returned by get() is valid.

Returns:

true if valid, otherwise false

getError

protected abstract String getError(long resultVa)

Return the error message.

Parameters:

resultVa - the virtual address of the result (not zero)

Returns:

a string of text

hasError

protected abstract boolean hasError(long resultVa)

Test whether an error occurred.

Parameters:

resultVa - the virtual address of the result (not zero)

Returns:

true if error, otherwise false

isValid

protected abstract boolean isValid(long resultVa)

Test whether the value returned by get() is valid.

Parameters:

resultVa - the virtual address of the result (not zero)

Returns:

true if valid, otherwise false