Top Description Methods
com.jogamp.nativewindow.util

public Interface DimensionImmutable

extends WriteCloneable, Comparable<DimensionImmutable>
Known Direct Implementers
com.jogamp.nativewindow.util.Dimension
Imports
com.jogamp.common.type.WriteCloneable

Immutable Dimension Interface, consisting of it's read only components:

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(final DimensionImmutable
the object to be compared.
d
)

Redeclares java.lang.Comparable.compareTo.

Compares square of size.

public boolean

Returns:

true if the two dimensions are equal; otherwise false.
equals
(Object obj)

Checks whether two dimensions objects are equal.

public int
public int
public int
Inherited from com.jogamp.common.type.WriteCloneable:
cloneMutable

Method Detail

compareToback to summary
public int compareTo(final DimensionImmutable d)

Redeclares java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares square of size.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
d:DimensionImmutable

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Checks whether two dimensions objects are equal. Two instances of DimensionReadOnly are equal if two components height and width are equal.

Returns:boolean

true if the two dimensions are equal; otherwise false.

Annotations
@Override
getHeightback to summary
public int getHeight()
getWidthback to summary
public int getWidth()
hashCodeback to summary
public int hashCode()
Annotations
@Override