Package be.theking90000.mumble.controller.spaces

Class ParticipantSpec

java.lang.Object

be.theking90000.mumble.controller.spaces.ParticipantSpec

public final class ParticipantSpec
extends Object

Complete desired state of a participant.

Updates replace this value atomically. In particular, changing spaceKey() expresses placement without a separate move operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ParticipantSpec.Builder	Builder for an immutable participant spec.

Method Summary

Modifier and Type	Method	Description
static ParticipantSpec.Builder	builder(SpaceKey spaceKey, String displayName)	Creates a builder with the required placement and display name.
String	displayName()	Returns the desired published display name.
boolean	equals(Object other)
int	hashCode()
boolean	serverDeaf()	Returns whether the server should prevent this participant from hearing voice.
boolean	serverMute()	Returns whether the server should prevent this participant from speaking.
SpaceKey	spaceKey()	Returns the desired semantic voice space.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static ParticipantSpec.Builder builder(SpaceKey spaceKey,
 String displayName)

Creates a builder with the required placement and display name.

Parameters:

spaceKey - desired semantic voice space

displayName - non-blank name to publish for the participant

Returns:

a new builder with both mute flags disabled

Throws:

NullPointerException - if spaceKey is null

spaceKey

public SpaceKey spaceKey()

Returns the desired semantic voice space.

Returns:

desired space key

displayName

public String displayName()

Returns the desired published display name.

Returns:

non-blank display name

serverMute

public boolean serverMute()

Returns whether the server should prevent this participant from speaking.

Returns:

desired server-mute state

serverDeaf

public boolean serverDeaf()

Returns whether the server should prevent this participant from hearing voice.

Returns:

desired server-deaf state

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object