com.mixer.interactive.resources

Class InteractiveResource<T extends InteractiveResource<T>>

java.lang.Object

com.mixer.interactive.resources.InteractiveResource<T>

All Implemented Interfaces:

IInteractiveUpdatable

Direct Known Subclasses:

InteractiveControl, InteractiveGroup, InteractiveParticipant, InteractiveScene

public abstract class InteractiveResource<T extends InteractiveResource<T>>
extends Object
implements IInteractiveUpdatable

The abstract class InteractiveResource is the superclass of all classes representing resources on the Interactive service.

Since:

1.0.0

Author:

Microsoft Corporation

See Also:

InteractiveControl, InteractiveParticipant, InteractiveGroup, InteractiveScene

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.gson.JsonElement	meta Json object holding the map of meta properties

Constructor Summary

Constructors

Constructor and Description
InteractiveResource()

Method Summary

Modifier and Type	Method and Description
T	addMetaProperty(String key, Object value) Adds a meta property to the meta property map object.
com.google.gson.JsonObject	getMeta() Returns the Json object holding the map of meta properties.
protected abstract T	getThis() Returns this as an instance of the specified generic.
T	setMeta(com.google.gson.JsonObject meta) Sets the Json object holding the map of meta properties.
abstract boolean	syncIfEqual(Collection<?> objects) Iterates through a Collection of Objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.mixer.interactive.resources.IInteractiveUpdatable

update

Field Detail

meta

protected com.google.gson.JsonElement meta

Json object holding the map of meta properties

Constructor Detail

InteractiveResource

public InteractiveResource()

Method Detail

getThis

protected abstract T getThis()

Returns this as an instance of the specified generic. Utilizes the getThis programming idiom.

Returns:

this as an object of type T

Since:

1.0.0

syncIfEqual

public abstract boolean syncIfEqual(Collection<?> objects)

Iterates through a Collection of Objects. If this is found to be in the Collection then this has it's values updated.

Parameters:

objects - A Collection of Objects

Returns:

A CompletableFuture that when complete returns true if the provided Collection contains this

Since:

1.0.0

getMeta

public com.google.gson.JsonObject getMeta()

Returns the Json object holding the map of meta properties.

Returns:

Json object holding the map of meta properties

Since:

1.0.0

setMeta

public T setMeta(com.google.gson.JsonObject meta)

Sets the Json object holding the map of meta properties.

Parameters:

meta - Json object holding the map of meta properties

Returns:

this for method chaining

Since:

1.0.0

addMetaProperty

public T addMetaProperty(String key,
                         Object value)

Adds a meta property to the meta property map object. If there already exists a meta property with the specified key, it's value is overwritten.

Parameters:

key - Meta property key

value - Meta property value

Returns:

this for method chaining

Since:

1.0.0