Record Class Message.Greeting

java.lang.Object

java.lang.Record

net.flectone.pulse.config.Message.Greeting

All Implemented Interfaces:

EnableSetting, SoundConfigSetting

Enclosing class:

Message

public static record Message.Greeting(Boolean enable, Destination destination, Sound sound)
extends Record
implements EnableSetting, SoundConfigSetting

Since:

1.7.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Message.Greeting.GreetingBuilder

Constructor Summary

Constructors

Constructor	Description
Greeting(Boolean enable, Destination destination, Sound sound)	Creates an instance of a Greeting record class.

Method Summary

Modifier and Type	Method	Description
static Message.Greeting.GreetingBuilder	builder()
Destination	destination()	Returns the value of the destination record component.
Boolean	enable()	Returns the value of the enable 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.
Sound	sound()	Returns the value of the sound record component.
Message.Greeting.GreetingBuilder	toBuilder()
final String	toString()	Returns a string representation of this record class.
Message.Greeting	withDestination(Destination destination)
Message.Greeting	withEnable(Boolean enable)
Message.Greeting	withSound(Sound sound)

Methods inherited from class Object

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

Constructor Details

Greeting

public Greeting(Boolean enable,
 Destination destination,
 Sound sound)

Creates an instance of a Greeting record class.

Parameters:

enable - the value for the enable record component

destination - the value for the destination record component

sound - the value for the sound record component

Method Details

builder

public static Message.Greeting.GreetingBuilder builder()

toBuilder

public Message.Greeting.GreetingBuilder toBuilder()

withEnable

public Message.Greeting withEnable(Boolean enable)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withDestination

public Message.Greeting withDestination(Destination destination)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withSound

public Message.Greeting withSound(Sound sound)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

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.

enable

public Boolean enable()

Returns the value of the enable record component.

Specified by:

enable in interface EnableSetting

Returns:

the value of the enable record component

destination

public Destination destination()

Returns the value of the destination record component.

Returns:

the value of the destination record component

sound

public Sound sound()

Returns the value of the sound record component.

Specified by:

sound in interface SoundConfigSetting

Returns:

the value of the sound record component

See Also:

• Sound