Record Class StConfiguration.AdminAPI

java.lang.Object

java.lang.Record

com.io7m.stonesignal.server.StConfiguration.AdminAPI

Enclosing class:

StConfiguration

public static record StConfiguration.AdminAPI(String host, int port, String apiKey, Optional<StConfiguration.TLS> tls)
extends Record

Constructor Summary

Constructors

Constructor	Description
AdminAPI(String host, int port, String apiKey, Optional<StConfiguration.TLS> tls)	Creates an instance of a AdminAPI record class.

Method Summary

Modifier and Type	Method	Description
String	apiKey()	Returns the value of the apiKey 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.
String	host()	Returns the value of the host record component.
int	port()	Returns the value of the port record component.
Optional<StConfiguration.TLS>	tls()	Returns the value of the tls 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

AdminAPI

public AdminAPI(@JsonPropertyDescription("The host address to which to bind.")
 String host,
 @JsonPropertyDescription("The host port to which to bind.")
 int port,
 @JsonPropertyDescription("The API key.")
 String apiKey,
 @JsonPropertyDescription("The TLS configuration.")
 Optional<StConfiguration.TLS> tls)

Creates an instance of a AdminAPI record class.

Parameters:

host - the value for the host record component

port - the value for the port record component

apiKey - the value for the apiKey record component

tls - the value for the tls 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

host

@JsonPropertyDescription("The host address to which to bind.")
public String host()

Returns the value of the host record component.

Returns:

the value of the host record component

port

@JsonPropertyDescription("The host port to which to bind.")
public int port()

Returns the value of the port record component.

Returns:

the value of the port record component

apiKey

@JsonPropertyDescription("The API key.")
public String apiKey()

Returns the value of the apiKey record component.

Returns:

the value of the apiKey record component

tls

@JsonPropertyDescription("The TLS configuration.")
public Optional<StConfiguration.TLS> tls()

Returns the value of the tls record component.

Returns:

the value of the tls record component