Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class PathResult

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

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

com.github.stephengold.joltjni.PathResult

All Implemented Interfaces:

ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

public final class PathResult
extends Result<PathConstraintPathRef>

Either an error or a PathConstraintPathRef. (native type: Result<Ref<PathConstraintPath>>)

Method Summary

Modifier and Type	Method	Description
PathConstraintPathRef	get()	Return the PathConstraintPathRef.
protected String	getError(long resultVa)	Return the error message.
protected boolean	hasError(long resultVa)	Test whether an error occurred.
protected boolean	isValid(long resultVa)	Test whether the value returned by get() is valid.

Methods inherited from class com.github.stephengold.joltjni.template.Result

getError, hasError, isValid

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

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

Methods inherited from class java.lang.Object

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

Method Details

get

public PathConstraintPathRef get()

Return the PathConstraintPathRef.

Specified by:

get in class Result<PathConstraintPathRef>

Returns:

a new JVM object with a new native object assigned

getError

protected String getError(long resultVa)

Description copied from class: Result

Return the error message.

Specified by:

getError in class Result<PathConstraintPathRef>

Parameters:

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

Returns:

a string of text

hasError

protected boolean hasError(long resultVa)

Description copied from class: Result

Test whether an error occurred.

Specified by:

hasError in class Result<PathConstraintPathRef>

Parameters:

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

Returns:

true if error, otherwise false

isValid

protected boolean isValid(long resultVa)

Description copied from class: Result

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

Specified by:

isValid in class Result<PathConstraintPathRef>

Parameters:

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

Returns:

true if valid, otherwise false