org.intellimate.izou.sdk.resource

Class Resource<T>

java.lang.Object

org.intellimate.izou.sdk.resource.Resource<T>

All Implemented Interfaces:

Identifiable, ResourceModel<T>

Direct Known Subclasses:

BroadcasterAvailablePlaylists, BroadcasterPlaylist, CapabilitiesResource, CommandResource, LastEncountered, MusicErrorResource, MusicUsageResource, NowPlayingResource, PlaybackStateResource, PlayerResource, PlaylistResource, PresenceResource, ProgressResource, SelectorResource, TrackInfoResource, UsingSoundResource, VolumeResource

public class Resource<T>
extends Object
implements ResourceModel<T>

An Resource is an object which is used to pass data from one part of the application to another. Note! This Object is immutable!

Constructor Summary

Constructors

Constructor and Description
Resource(String resourceID) creates a new Resource.
Resource(String resourceID, Identification provider) creates a new Resource.
Resource(String resourceID, Identification provider, Identification consumer) creates a new Resource.
Resource(String resourceID, Identification provider, T t) creates a new Resource.
Resource(String resourceID, Identification provider, T t, Identification consumer) creates a new Resource.
Resource(String resourceID, T t, Identification consumer) creates a new Resource.

Method Summary

Modifier and Type	Method and Description
Identification	getConsumer() returns the consumer of the object (if set).
String	getID() An ID must always be unique.
Identification	getProvider() returns the provider of the Resource.
T	getResource() returns the associated Resource data if set.
String	getResourceID() returns the ID of the Resource.
boolean	hasProvider() returns whether a provider is set
Resource<T>	setConsumer(Identification consumer) sets who should or has consumed the Resource Object.
Resource<T>	setProvider(Identification provider) sets who should or has provided the Resource Object.
Resource<T>	setResource(T resource) sets the Resource data.
List<Resource>	toList() creates a list with this Element in it.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Constructor Detail

Resource

public Resource(String resourceID)

creates a new Resource.

Parameters:

resourceID - the ID of the Resource

Resource

public Resource(String resourceID,
                Identification provider)

creates a new Resource.

Parameters:

resourceID - the ID of the Resource

provider - the Provider of the Resource

Resource

public Resource(String resourceID,
                Identification provider,
                T t)

creates a new Resource.

Parameters:

resourceID - the ID of the Resource

provider - the Provider of the Resource

t - the resource

Resource

public Resource(String resourceID,
                T t,
                Identification consumer)

creates a new Resource.

Parameters:

resourceID - the ID of the Resource

consumer - the ID of the Consumer

t - the resource

Resource

public Resource(String resourceID,
                Identification provider,
                Identification consumer)

creates a new Resource.

Parameters:

resourceID - the ID of the Resource

provider - the Provider of the Resource

consumer - the ID of the Consumer

Resource

public Resource(String resourceID,
                Identification provider,
                T t,
                Identification consumer)

creates a new Resource.

Parameters:

resourceID - the ID of the Resource

provider - the Provider of the Resource

t - the resource

consumer - the ID of the Consumer

Method Detail

getResource

public T getResource()

returns the associated Resource data if set. This method is thread-safe.

Specified by:

getResource in interface ResourceModel<T>

Returns:

null or resource data

setResource

public Resource<T> setResource(T resource)

sets the Resource data.

Note! this Object is immutable!

Parameters:

resource - the data to set

Returns:

the Resource

getResourceID

public String getResourceID()

returns the ID of the Resource. This method is thread-safe.

Specified by:

getResourceID in interface ResourceModel<T>

Returns:

a String containing the ID of the resource

getProvider

public Identification getProvider()

returns the provider of the Resource. This method is thread-safe.

Specified by:

getProvider in interface ResourceModel<T>

Returns:

an Identification describing the provider of the Resource or null if not set

hasProvider

public boolean hasProvider()

returns whether a provider is set

Specified by:

hasProvider in interface ResourceModel<T>

Returns:

true if this resource has an provider, false if not

setProvider

public Resource<T> setProvider(Identification provider)

sets who should or has provided the Resource Object.

Note! this Object is immutable!

Parameters:

provider - an Identification describing the provider of the Resource

Returns:

the Resource

getConsumer

public Identification getConsumer()

returns the consumer of the object (if set).

Specified by:

getConsumer in interface ResourceModel<T>

Returns:

null or an Identification describing the consumer of the Resource

setConsumer

public Resource<T> setConsumer(Identification consumer)

sets who should or has consumed the Resource Object.

Note! this Object is immutable!

Parameters:

consumer - an Identification describing the consumer of the Resource

Returns:

new Resource

toList

public List<Resource> toList()

creates a list with this Element in it.

Returns:

a list

getID

public String getID()

An ID must always be unique. A Class like Activator or OutputPlugin can just provide their .class.getCanonicalName() If you have to implement this interface multiple times, just concatenate unique Strings to .class.getCanonicalName()

Specified by:

getID in interface Identifiable

Returns:

A String containing an ID

toString

public String toString()

Overrides:

toString in class Object