Record Class St1AdminDevice

java.lang.Object

java.lang.Record

com.io7m.stonesignal.protocol.admin.v1.St1AdminDevice

public record St1AdminDevice(UUID deviceId, String deviceKey, String name, Map<String,String> metadata)
extends Record

A device.

Constructor Summary

Constructors

Constructor	Description
St1AdminDevice(UUID deviceId, String deviceKey, String name, Map<String,String> metadata)	Creates an instance of a St1AdminDevice record class.

Method Summary

Modifier and Type	Method	Description
UUID	deviceId()	Returns the value of the deviceId record component.
String	deviceKey()	Returns the value of the deviceKey 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.
Map<String,String>	metadata()	Returns the value of the metadata record component.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

St1AdminDevice

public St1AdminDevice(@JsonPropertyDescription("The device ID.")
 UUID deviceId,
 @JsonPropertyDescription("The device key.")
 String deviceKey,
 @JsonPropertyDescription("The device name.")
 String name,
 @JsonPropertyDescription("The device metadata.")
 Map<String,String> metadata)

Creates an instance of a St1AdminDevice record class.

Parameters:

deviceId - the value for the deviceId record component

deviceKey - the value for the deviceKey record component

name - the value for the name record component

metadata - the value for the metadata record component

Method Details

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.

deviceId

@JsonPropertyDescription("The device ID.")
public UUID deviceId()

Returns the value of the deviceId record component.

Returns:

the value of the deviceId record component

deviceKey

@JsonPropertyDescription("The device key.")
public String deviceKey()

Returns the value of the deviceKey record component.

Returns:

the value of the deviceKey record component

name

@JsonPropertyDescription("The device name.")
public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

metadata

@JsonPropertyDescription("The device metadata.")
public Map<String,String> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component