Package velox.api.layer1.messages.plugin

Record Class DownloadPluginRequest

java.lang.Object

java.lang.Record

velox.api.layer1.messages.plugin.DownloadPluginRequest

Record Components:

qualifier - Qualifier returned by AvailablePluginsRequest

layer - plugin layer into which the plugin should be installed

callback - callback that receives outcomes reported directly by this request

All Implemented Interfaces:

BmDownMessage<DownloadPluginRequest,Awaitable>

@DefaultQualifier(afu.org.checkerframework.checker.nullness.qual.NonNull.class)
public record DownloadPluginRequest(PluginQualifier qualifier, PluginLayer layer, DownloadPluginRequest.Callback callback)
extends Record
implements BmDownMessage<DownloadPluginRequest,Awaitable>

Request to download and install a plugin specified by its qualifier into the specified PluginLayer.

The qualifier should be obtained through AvailablePluginsRequest and passed to this request directly.

Processing is asynchronous. The returned Awaitable can be used from a background thread to wait until the request is processed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DownloadPluginRequest.Callback	Receives outcomes reported directly by a DownloadPluginRequest.
static interface	DownloadPluginRequest.Issue	Describes an issue reported by a DownloadPluginRequest.

Constructor Summary

Constructors

Constructor	Description
DownloadPluginRequest(PluginQualifier qualifier, PluginLayer layer, DownloadPluginRequest.Callback callback)	Creates an instance of a DownloadPluginRequest record class.

Method Summary

Modifier and Type	Method	Description
DownloadPluginRequest.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.
PluginLayer	layer()	Returns the value of the layer record component.
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

DownloadPluginRequest

public DownloadPluginRequest(PluginQualifier qualifier,
 PluginLayer layer,
 DownloadPluginRequest.Callback callback)

Creates an instance of a DownloadPluginRequest record class.

Parameters:

qualifier - the value for the qualifier record component

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

qualifier

public PluginQualifier qualifier()

Returns the value of the qualifier record component.

Returns:

the value of the qualifier record component

layer

public PluginLayer layer()

Returns the value of the layer record component.

Returns:

the value of the layer record component

callback

public DownloadPluginRequest.Callback callback()

Returns the value of the callback record component.

Returns:

the value of the callback record component