Package live.crowdcontrol.cc4j.websocket.http

Record Class CustomEffectParameter

java.lang.Object

java.lang.Record

live.crowdcontrol.cc4j.websocket.http.CustomEffectParameter

public record CustomEffectParameter(@NotNull String type, @NotNull String name, @Nullable Map<String,CustomEffectParameterOption> options)
extends Record

Constructor Summary

Constructors

Constructor	Description
CustomEffectParameter(@NotNull String type, @NotNull String name, @Nullable Map<String,CustomEffectParameterOption> options)	Creates an instance of a CustomEffectParameter record class.

Method Summary

Modifier and Type	Method	Description
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.
static CustomEffectParameter	hexColor(@NotNull String name)
@NotNull String	name()	Returns the value of the name record component.
@Nullable Map<String,CustomEffectParameterOption>	options()	Returns the value of the options record component.
static CustomEffectParameter	options(@NotNull String name, @NotNull Map<String,CustomEffectParameterOption> options)
final String	toString()	Returns a string representation of this record class.
@NotNull String	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

CustomEffectParameter

public CustomEffectParameter(@NotNull
 @NotNull String type,
 @NotNull
 @NotNull String name,
 @Nullable
 @Nullable Map<String,CustomEffectParameterOption> options)

Creates an instance of a CustomEffectParameter record class.

Parameters:

type - the value for the type record component

name - the value for the name record component

options - the value for the options record component

Method Details

options

public static CustomEffectParameter options(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull Map<String,CustomEffectParameterOption> options)

hexColor

public static CustomEffectParameter hexColor(@NotNull
 @NotNull String name)

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

@NotNull
public @NotNull String type()

Returns the value of the type record component.

Returns:

the value of the type record component

name

@NotNull
public @NotNull String name()

Returns the value of the name record component.

Returns:

the value of the name record component

options

@Nullable
public @Nullable Map<String,CustomEffectParameterOption> options()

Returns the value of the options record component.

Returns:

the value of the options record component