Package ca.corbett.extras.gradient

Record Class Gradient

java.lang.Object

java.lang.Record

ca.corbett.extras.gradient.Gradient

public record Gradient(GradientType type, Color color1, Color color2)
extends Record

Constructor Summary

Constructors

Constructor	Description
Gradient(GradientType type, Color color1, Color color2)	Creates an instance of a Gradient record class.

Method Summary

Modifier and Type	Method	Description
Color	color1()	Returns the value of the color1 record component.
Color	color2()	Returns the value of the color2 record component.
static Gradient	createDefault()
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.
GradientType	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

Gradient

public Gradient(GradientType type,
 Color color1,
 Color color2)

Creates an instance of a Gradient record class.

Parameters:

type - the value for the type record component

color1 - the value for the color1 record component

color2 - the value for the color2 record component

Method Details

createDefault

public static Gradient createDefault()

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.

type

public GradientType type()

Returns the value of the type record component.

Returns:

the value of the type record component

color1

public Color color1()

Returns the value of the color1 record component.

Returns:

the value of the color1 record component

color2

public Color color2()

Returns the value of the color2 record component.

Returns:

the value of the color2 record component