org.jmythapi.protocol.annotation
Annotation Type MythProtocolCmd

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface MythProtocolCmd

This annotation describes a protocol command.

Optional Element Summary

String	parentCommand
MythProtoVersionAnnotation	protoVersion
Class<?>	responseClass TODO: currently only used for documentation purposes
String	subCommandPos

protoVersion

public abstract MythProtoVersionAnnotation protoVersion

Returns:

the MythTV-protocol version where the command was introduced.

Default:

@org.jmythapi.protocol.annotation.MythProtoVersionAnnotation(from=org.jmythapi.protocol.ProtocolVersion.PROTO_VERSION_00, to=org.jmythapi.protocol.ProtocolVersion.PROTO_VERSION_LATEST)

parentCommand

public abstract String parentCommand

Returns:

the parent-command if any or "" if no parent exists.

Default:

""

subCommandPos

public abstract String subCommandPos

Returns:

the position of sub-commands, if any. e.g.:

"1" means in the second IMythPacket argument.
"0.1" means in the second command-argument of the IMythCommand

Default:

""

responseClass

public abstract Class<?> responseClass

TODO: currently only used for documentation purposes

Returns:

the class used to parse the response

Default:

java.lang.Object.class