Top Description Fields Constructors Methods
org.lwjgl

public abstract Class PointerWrapperAbstract

extends Object
implements PointerWrapper
Class Inheritance
All Implemented Interfaces
org.lwjgl.PointerWrapper
Known Direct Subclasses
org.lwjgl.opencl.CLContextCallback, org.lwjgl.opencl.CLEventCallback, org.lwjgl.opencl.CLFunctionAddress, org.lwjgl.opencl.CLMemObjectDestructorCallback, org.lwjgl.opencl.CLNativeKernel, org.lwjgl.opencl.CLObject, org.lwjgl.opencl.CLPrintfCallback, org.lwjgl.opencl.CLProgramCallback, org.lwjgl.opengl.AMDDebugOutputCallback, org.lwjgl.opengl.ARBDebugOutputCallback, org.lwjgl.opengl.GLSync, org.lwjgl.opengl.KHRDebugCallback, org.lwjgl.opengles.EGLConfig, org.lwjgl.opengles.EGLContext, org.lwjgl.opengles.EGLDisplay, org.lwjgl.opengles.EGLImageOES, org.lwjgl.opengles.EGLSurface, org.lwjgl.opengles.EGLSyncKHR, org.lwjgl.opengles.EGLSyncNV, org.lwjgl.opengles.GLSync, org.lwjgl.opengles.KHRDebugCallback

Base PointerWrapper implementation.
Author
Spasi

Field Summary

Modifier and TypeField and Description
protected final long

Constructor Summary

AccessConstructor and Description
protected
PointerWrapperAbstract(final long pointer)

Method Summary

Modifier and TypeMethod and Description
public final void
checkValid()

Checks if the pointer is valid and throws an IllegalStateException if it is not.

public boolean
equals(final Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public final long
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean

Returns:

true if the pointer is valid
isValid
()

Returns true if this object represents a valid pointer.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

pointerback to summary
protected final long pointer

Constructor Detail

PointerWrapperAbstractback to summary
protected PointerWrapperAbstract(final long pointer)

Method Detail

checkValidback to summary
public final void checkValid()

Checks if the pointer is valid and throws an IllegalStateException if it is not. This method is a NO-OP, unless the org.lwjgl.util.Debug property has been set to true.

equalsback to summary
public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getPointerback to summary
public final long getPointer()

Implements org.lwjgl.PointerWrapper.getPointer.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

isValidback to summary
public boolean isValid()

Returns true if this object represents a valid pointer. The pointer might be invalid because it is NULL or because some other action has deleted the object that this pointer represents.

Returns:boolean

true if the pointer is valid

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object