Package velox.api.layer1.messages.plugin.addon

Record Class OpenAddonRequest

java.lang.Object

java.lang.Record

velox.api.layer1.messages.plugin.addon.OpenAddonRequest

Record Components:

alias - alias for which the add-on should be opened

qualifier - Qualifier of an active add-on

callback - callback that receives the processing result or an issue

All Implemented Interfaces:

BmDownMessage<OpenAddonRequest,Awaitable>

@DefaultQualifier(org.checkerframework.checker.nullness.qual.NonNull.class)
public record OpenAddonRequest(String alias, PluginQualifier qualifier, OpenAddonRequest.Callback callback)
extends Record
implements BmDownMessage<OpenAddonRequest,Awaitable>

Request to open an active add-on for a given alias.

The qualifier must identify an active add-on and should be obtained through AvailablePluginsRequest.

Processing is asynchronous. The returned Awaitable can be used to wait for completion from a background thread.

Note: opening an add-on attempts to enable all of its entry points for the given alias. Entry points that are not currently available are returned through OpenAddonRequest.Callback.onSuccess(List, List) in the notFound list.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenAddonRequest.Callback	Receives the asynchronous result of an OpenAddonRequest.
static interface	OpenAddonRequest.Issue	Describes why an OpenAddonRequest could not be completed.

Constructor Summary

Constructors

Constructor	Description
OpenAddonRequest(String alias, PluginQualifier qualifier, OpenAddonRequest.Callback callback)	Creates an instance of a OpenAddonRequest record class.

Method Summary

Modifier and Type	Method	Description
String	alias()	Returns the value of the alias record component.
OpenAddonRequest.Callback	callback()	Returns the value of the callback 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.
PluginQualifier	qualifier()	Returns the value of the qualifier 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

OpenAddonRequest

public OpenAddonRequest(String alias,
 PluginQualifier qualifier,
 OpenAddonRequest.Callback callback)

Creates an instance of a OpenAddonRequest record class.

Parameters:

alias - the value for the alias record component

qualifier - the value for the qualifier record component

callback - the value for the callback 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.

alias

public String alias()

Returns the value of the alias record component.

Returns:

the value of the alias record component

qualifier

public PluginQualifier qualifier()

Returns the value of the qualifier record component.

Returns:

the value of the qualifier record component

callback

public OpenAddonRequest.Callback callback()

Returns the value of the callback record component.

Returns:

the value of the callback record component