org.jmythapi
Interface ISetting

All Superinterfaces:

Cloneable, IPropertyAware<ISetting.Props>, IVersionable

All Known Implementing Classes:

Setting, Setting

public interface ISetting
extends IVersionable, IPropertyAware<ISetting.Props>

An interface to get the value of a MythTV setting.

This interface represents the response to a IBackend.querySetting(String, String) request.
This interface is property-aware. See the properties-list for all properties of this interface.

Response example:

<0>DATA_BASE64: DE

Nested Class Summary

static class

ISetting.Props Properties of an ISetting response.

Method Summary

String	getData() Gets the settings value
<T> T	getData(Class<T> dataType) Gets the settings value and converts it into the given data type.
String	getHostname() Gets the backends hostname this settings belongs to.
String	getName() The name of the setting.

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.IPropertyAware

getProperties, getProperty, getPropertyClass, getPropertyCount, getPropertyIndex, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValues, setPropertyValue, setPropertyValue, setPropertyValueObject

Method Detail

getData

String getData()

Gets the settings value

Returns:

The value of the setting.

See Also:

ISetting.Props.DATA

getData

<T> T getData(Class<T> dataType)

Gets the settings value and converts it into the given data type.

Type Parameters:

T - the data type

Parameters:

dataType - the data type

Returns:

the settings value

getHostname

String getHostname()

Gets the backends hostname this settings belongs to.

Returns:

the name of the host or null

getName

String getName()

The name of the setting.

Returns:

the settings name