org.jmythapi.protocol.response
Enum IRecorderChannelPrefixStatus.Props

java.lang.Object
  java.lang.Enum<IRecorderChannelPrefixStatus.Props>
      org.jmythapi.protocol.response.IRecorderChannelPrefixStatus.Props

All Implemented Interfaces:

Serializable, Comparable<IRecorderChannelPrefixStatus.Props>

Enclosing interface:

IRecorderChannelPrefixStatus

public static enum IRecorderChannelPrefixStatus.Props
extends Enum<IRecorderChannelPrefixStatus.Props>

The properties of an IRecorderChannelPrefixStatus response.

MythTV Protocol Version Matrix
		Protocol
Name	Type	Range	00	24	-1
IS_PREFIX_MATCH	Boolean	[00,-1)	X	X	X
IS_COMPLETE_MATCH	Boolean	[00,-1)	X	X	X
IS_EXTRA_CHAR_USEFUL	Boolean	[24,-1)	-	X	X
NEEDED_SPACER	String	[24,-1)	-	X	X

Enum Constant Summary

IS_COMPLETE_MATCH
If the prefix matches any channel entirely (i.e. prefix == channum), then this is set to true.

IS_EXTRA_CHAR_USEFUL
If adding another character could reduce the number of channels the prefix matches then this is set to true.

IS_PREFIX_MATCH
If the prefix matches at least one channel on the recorder, this is set to true.

NEEDED_SPACER
If in order for the prefix to match a channel, a spacer needs to be added, the first matching spacer is returned.

Method Summary

static IRecorderChannelPrefixStatus.Props	valueOf(String name) Returns the enum constant of this type with the specified name.
static IRecorderChannelPrefixStatus.Props[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IS_PREFIX_MATCH

public static final IRecorderChannelPrefixStatus.Props IS_PREFIX_MATCH

If the prefix matches at least one channel on the recorder, this is set to true.

See Also:

IRecorderChannelPrefixStatus.isPrefixMatch()

IS_COMPLETE_MATCH

public static final IRecorderChannelPrefixStatus.Props IS_COMPLETE_MATCH

If the prefix matches any channel entirely (i.e. prefix == channum), then this is set to true.

See Also:

IRecorderChannelPrefixStatus.isCompleteMatch()

IS_EXTRA_CHAR_USEFUL

public static final IRecorderChannelPrefixStatus.Props IS_EXTRA_CHAR_USEFUL

If adding another character could reduce the number of channels the prefix matches then this is set to true.

Since:

24

See Also:

IRecorderChannelPrefixStatus.isExtraCharUseful()

NEEDED_SPACER

public static final IRecorderChannelPrefixStatus.Props NEEDED_SPACER

If in order for the prefix to match a channel, a spacer needs to be added, the first matching spacer is returned.

Since:

24

See Also:

IRecorderChannelPrefixStatus.getNeededSpacer()

Method Detail

values

public static IRecorderChannelPrefixStatus.Props[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IRecorderChannelPrefixStatus.Props c : IRecorderChannelPrefixStatus.Props.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IRecorderChannelPrefixStatus.Props valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null