Package com.jtprince.coordinateoffset

Record Class OffsetData

java.lang.Object

java.lang.Record

com.jtprince.coordinateoffset.OffsetData

Record Components:

offset - The offset that was generated.

source - Source of the offset. The offset may have come from an offset provider, or the offset may have been generated in response to an offset bypass or a command.

context - Context in which the offset was generated.

@NullMarked
public record OffsetData(FixedOffset offset, OffsetData.Source source, OffsetProviderContext context)
extends Record

Container for an offset which was generated for a specific context, and where the offset came from.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OffsetData.Source

Constructor Summary

Constructors

Constructor	Description
OffsetData(FixedOffset offset, OffsetData.Source source, OffsetProviderContext context)	Creates an instance of a OffsetData record class.

Method Summary

Modifier and Type	Method	Description
OffsetProviderContext	context()	Returns the value of the context record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
FixedOffset	offset()	Returns the value of the offset record component.
OffsetData.Source	source()	Returns the value of the source record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

OffsetData

public OffsetData(FixedOffset offset,
 OffsetData.Source source,
 OffsetProviderContext context)

Creates an instance of a OffsetData record class.

Parameters:

offset - the value for the offset record component

source - the value for the source record component

context - the value for the context record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

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

offset

public FixedOffset offset()

Returns the value of the offset record component.

Returns:

the value of the offset record component

source

public OffsetData.Source source()

Returns the value of the source record component.

Returns:

the value of the source record component

context

public OffsetProviderContext context()

Returns the value of the context record component.

Returns:

the value of the context record component