agi.foundation.terrain

(agi.foundation.models-2023r1.jar)

Class TerrainCacheTimeStamp

java.lang.Object

agi.foundation.terrain.TerrainCacheTimeStamp

All Implemented Interfaces:

ICloneable, IEquatable<TerrainCacheTimeStamp>, ValueType, Cloneable, Comparable<TerrainCacheTimeStamp>

public final class TerrainCacheTimeStamp
extends Object
implements Comparable<TerrainCacheTimeStamp>, IEquatable<TerrainCacheTimeStamp>, ValueType, ICloneable

A time stamp used to indicate, in a relative sense, when various terrain regions were last utilized.

Constructor Summary

Constructors

Constructor and Description
TerrainCacheTimeStamp() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
TerrainCacheTimeStamp	clone() Creates and returns a copy of this object.
int	compareTo(TerrainCacheTimeStamp other) Compares this instance with another instance of the same type.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
static boolean	equals(TerrainCacheTimeStamp left, TerrainCacheTimeStamp right) Returns true if the two instances are exactly equal.
boolean	equalsType(TerrainCacheTimeStamp other) Indicates whether another instance of this type is exactly equal to this instance.
static boolean	greaterThan(TerrainCacheTimeStamp left, TerrainCacheTimeStamp right) Returns true if left is greater than right.
static boolean	greaterThanOrEqual(TerrainCacheTimeStamp left, TerrainCacheTimeStamp right) Returns true if left is greater than or equal to right.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	lessThan(TerrainCacheTimeStamp left, TerrainCacheTimeStamp right) Returns true if left is less than right.
static boolean	lessThanOrEqual(TerrainCacheTimeStamp left, TerrainCacheTimeStamp right) Returns true if left is less than or equal to right.
static boolean	notEquals(TerrainCacheTimeStamp left, TerrainCacheTimeStamp right) Returns true if the two instances are not exactly equal.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TerrainCacheTimeStamp

public TerrainCacheTimeStamp()

Initializes a new instance.

Method Detail

lessThan

public static boolean lessThan(@Nonnull
                               TerrainCacheTimeStamp left,
                               @Nonnull
                               TerrainCacheTimeStamp right)

Returns true if left is less than right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is less than right; otherwise false.

greaterThan

public static boolean greaterThan(@Nonnull
                                  TerrainCacheTimeStamp left,
                                  @Nonnull
                                  TerrainCacheTimeStamp right)

Returns true if left is greater than right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is greater than right; otherwise false.

lessThanOrEqual

public static boolean lessThanOrEqual(@Nonnull
                                      TerrainCacheTimeStamp left,
                                      @Nonnull
                                      TerrainCacheTimeStamp right)

Returns true if left is less than or equal to right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is less than or equal to right; otherwise false.

greaterThanOrEqual

public static boolean greaterThanOrEqual(@Nonnull
                                         TerrainCacheTimeStamp left,
                                         @Nonnull
                                         TerrainCacheTimeStamp right)

Returns true if left is greater than or equal to right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is greater than or equal to right; otherwise false.

equals

public static boolean equals(@Nonnull
                             TerrainCacheTimeStamp left,
                             @Nonnull
                             TerrainCacheTimeStamp right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                TerrainCacheTimeStamp left,
                                @Nonnull
                                TerrainCacheTimeStamp right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.

compareTo

public final int compareTo(@Nonnull
                           TerrainCacheTimeStamp other)

Compares this instance with another instance of the same type.

Specified by:

compareTo in interface Comparable<TerrainCacheTimeStamp>

Parameters:

other - An object to compare with this instance.

Returns:

A value indicating the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance is less than other.
Zero	This instance is equal to other.
Greater than zero	This instance is greater than other.

equalsType

public final boolean equalsType(@Nonnull
                                TerrainCacheTimeStamp other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<TerrainCacheTimeStamp>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

clone

@Nonnull
public final TerrainCacheTimeStamp clone()

Description copied from class: java.lang.Object

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

a clone of this instance.

See Also:

Cloneable