org.intellimate.izou.sdk.frameworks.music.resources

Class CommandResource

java.lang.Object

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

org.intellimate.izou.sdk.frameworks.music.resources.CommandResource

All Implemented Interfaces:

Identifiable, ResourceModel<String>

public class CommandResource
extends Resource<String>

A resource containing commands for the player.

Version:

1.0

Author:

LeanderK

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANGE_PLAYBACK
static String	CHANGE_VOLUME
static String	JUMP
static String	NEXT
static String	PAUSE
static String	PLAY
static String	PREVIOUS
static String	ResourceID
static String	SELECT_TRACK
static String	STOP

Method Summary

Modifier and Type	Method and Description
static Optional<CommandResource>	createCommandResource(Identification provider, String command, Capabilities capabilities, Context context) creates a new Resource.
static boolean	verify(String command, Capabilities capabilities) verifies tha the command is legal and able to be executed
static boolean	verifyCapabilities(String command, Capabilities capabilities) verifies that the player is capable of handling the command
static boolean	verifyCommand(String command) verifies that an command is not malformed

Methods inherited from class org.intellimate.izou.sdk.resource.Resource

getConsumer, getID, getProvider, getResource, getResourceID, hasProvider, setConsumer, setProvider, setResource, toList, 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

Field Detail

ResourceID

public static final String ResourceID

See Also:

Constant Field Values

PLAY

public static final String PLAY

See Also:

Constant Field Values

PAUSE

public static final String PAUSE

See Also:

Constant Field Values

STOP

public static final String STOP

See Also:

Constant Field Values

SELECT_TRACK

public static final String SELECT_TRACK

See Also:

Constant Field Values

NEXT

public static final String NEXT

See Also:

Constant Field Values

PREVIOUS

public static final String PREVIOUS

See Also:

Constant Field Values

JUMP

public static final String JUMP

See Also:

Constant Field Values

CHANGE_PLAYBACK

public static final String CHANGE_PLAYBACK

See Also:

Constant Field Values

CHANGE_VOLUME

public static final String CHANGE_VOLUME

See Also:

Constant Field Values

Method Detail

createCommandResource

public static Optional<CommandResource> createCommandResource(Identification provider,
                                                              String command,
                                                              Capabilities capabilities,
                                                              Context context)

creates a new Resource.

Parameters:

provider - the Provider of the Resource

command - the resource

capabilities - the capabilities of the player

context - used for logging

Returns:

the commandResource if nothing illegal was passed

verifyCommand

public static boolean verifyCommand(String command)

verifies that an command is not malformed

Parameters:

command - the Command

Returns:

false if malformed

verifyCapabilities

public static boolean verifyCapabilities(String command,
                                         Capabilities capabilities)

verifies that the player is capable of handling the command

Parameters:

command - the command

capabilities - the capabilities

Returns:

true if capable, false if not

verify

public static boolean verify(String command,
                             Capabilities capabilities)

verifies tha the command is legal and able to be executed

Parameters:

command - the command

capabilities - the capabilities

Returns:

true if able, false if not