Package controller

Record Class ControllerLayer

java.lang.Object

java.lang.Record

controller.ControllerLayer

All Implemented Interfaces:

Comparable<ControllerLayer>

public record ControllerLayer(int value)
extends Record
implements Comparable<ControllerLayer>

A class to represent a layer on wich elements are drawn.

BOTTOM: 100 (you can de- or increase this value if you need to)
DEFAULT: 200 (you can de- or increase this value if you need to)
TOP: 300 (you can de- or increase this value if you need to)

ControllerLayers with a higher value are drawn last (i.e. over other entities).

You can construct a user-defined ControllerLayer with any possible integer value.

Field Summary

Fields

Modifier and Type	Field	Description
static final ControllerLayer	BOTTOM
static final int	BOTTOM_VALUE
static final ControllerLayer	DEFAULT
static final int	DEFAULT_VALUE
static final ControllerLayer	TOP
static final int	TOP_VALUE

Constructor Summary

Constructors

Constructor	Description
ControllerLayer(int value)	Creates an instance of a ControllerLayer record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(ControllerLayer o)
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.
final String	toString()	Returns a string representation of this record class.
int	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

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

Field Details

BOTTOM_VALUE

public static final int BOTTOM_VALUE

See Also:

• Constant Field Values

DEFAULT_VALUE

public static final int DEFAULT_VALUE

See Also:

• Constant Field Values

TOP_VALUE

public static final int TOP_VALUE

See Also:

• Constant Field Values

BOTTOM

public static final ControllerLayer BOTTOM

DEFAULT

public static final ControllerLayer DEFAULT

TOP

public static final ControllerLayer TOP

Constructor Details

ControllerLayer

public ControllerLayer(int value)

Creates an instance of a ControllerLayer record class.

Parameters:

value - the value for the value record component

Method Details

compareTo

public int compareTo(ControllerLayer o)

Specified by:

compareTo in interface Comparable<ControllerLayer>

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 '=='.

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.

value

public int value()

Returns the value of the value record component.

Returns:

the value of the value record component