Package velox.api.layer1.messages.plugin

Record Class AvailablePluginsRequest

java.lang.Object

java.lang.Record

velox.api.layer1.messages.plugin.AvailablePluginsRequest

All Implemented Interfaces:

BmDownMessage<AvailablePluginsRequest,Awaitable>

@DefaultQualifier(org.checkerframework.checker.nullness.qual.NonNull.class)
public record AvailablePluginsRequest(PluginLayer pluginLayer, AvailablePluginsRequest.Callback callback, AvailablePluginsRequest.CacheMode cacheMode, AvailablePluginsRequest.TargetGroup targetGroup)
extends Record
implements BmDownMessage<AvailablePluginsRequest,Awaitable>

Request to get the list of available plugins for a specific plugin layer. Should be handled in asynchronous manner, you can block on returned Awaitable if you want to make sure the request is processed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AvailablePluginsRequest.CacheMode
static interface	AvailablePluginsRequest.Callback
static interface	AvailablePluginsRequest.Issue
static enum	AvailablePluginsRequest.TargetGroup

Constructor Summary

Constructors

Constructor	Description
AvailablePluginsRequest(PluginLayer pluginLayer, AvailablePluginsRequest.Callback callback, AvailablePluginsRequest.CacheMode cacheMode, AvailablePluginsRequest.TargetGroup targetGroup)	Creates an instance of a AvailablePluginsRequest record class.

Method Summary

Modifier and Type	Method	Description
AvailablePluginsRequest.CacheMode	cacheMode()	Returns the value of the cacheMode record component.
AvailablePluginsRequest.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.
static AvailablePluginsRequest	fresh(PluginLayer pluginLayer, AvailablePluginsRequest.TargetGroup targetGroup, AvailablePluginsRequest.Callback callback)
static AvailablePluginsRequest	freshIfNoCache(PluginLayer pluginLayer, AvailablePluginsRequest.TargetGroup targetGroup, AvailablePluginsRequest.Callback callback)
static AvailablePluginsRequest	fromCache(PluginLayer pluginLayer, AvailablePluginsRequest.TargetGroup targetGroup, AvailablePluginsRequest.Callback callback)
final int	hashCode()	Returns a hash code value for this object.
PluginLayer	pluginLayer()	Returns the value of the pluginLayer record component.
AvailablePluginsRequest.TargetGroup	targetGroup()	Returns the value of the targetGroup 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

AvailablePluginsRequest

public AvailablePluginsRequest(PluginLayer pluginLayer,
 AvailablePluginsRequest.Callback callback,
 AvailablePluginsRequest.CacheMode cacheMode,
 AvailablePluginsRequest.TargetGroup targetGroup)

Creates an instance of a AvailablePluginsRequest record class.

Parameters:

pluginLayer - the value for the pluginLayer record component

callback - the value for the callback record component

cacheMode - the value for the cacheMode record component

targetGroup - the value for the targetGroup record component

Method Details

fromCache

public static AvailablePluginsRequest fromCache(PluginLayer pluginLayer,
 AvailablePluginsRequest.TargetGroup targetGroup,
 AvailablePluginsRequest.Callback callback)

fresh

public static AvailablePluginsRequest fresh(PluginLayer pluginLayer,
 AvailablePluginsRequest.TargetGroup targetGroup,
 AvailablePluginsRequest.Callback callback)

freshIfNoCache

public static AvailablePluginsRequest freshIfNoCache(PluginLayer pluginLayer,
 AvailablePluginsRequest.TargetGroup targetGroup,
 AvailablePluginsRequest.Callback callback)

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.

pluginLayer

public PluginLayer pluginLayer()

Returns the value of the pluginLayer record component.

Returns:

the value of the pluginLayer record component

callback

public AvailablePluginsRequest.Callback callback()

Returns the value of the callback record component.

Returns:

the value of the callback record component

cacheMode

public AvailablePluginsRequest.CacheMode cacheMode()

Returns the value of the cacheMode record component.

Returns:

the value of the cacheMode record component

targetGroup

public AvailablePluginsRequest.TargetGroup targetGroup()

Returns the value of the targetGroup record component.

Returns:

the value of the targetGroup record component