org.jmythapi.protocol.response
Interface IFreeSpaceSummary

All Superinterfaces:

Cloneable, IBasicFreeSpace, IPropertyAware<IFreeSpaceSummary.Props>, IVersionable

All Known Implementing Classes:

FreeSpaceSummary

public interface IFreeSpaceSummary
extends IBasicFreeSpace, IVersionable, IPropertyAware<IFreeSpaceSummary.Props>

An interface to get the free disk-space of a MythTV backend.

This interface represents the response to a backend.queryFreeSpaceSummary request.
This interface is property-aware. See the properties-list for all properties of this interface.

Request example:

    IFreeSpaceSummary freeSpaceSummary = backend.queryFreeSpaceSummary();
    System.out.println(String.format(
       "MythTV has used %d space out of %d.",
       freeSpaceSummary.getUsedSpace(),
       freeSpaceSummary.getTotalSpace()
    ));
 

Response example:

<0>TOTAL_SPACE1: 0 | <1>TOTAL_SPACE2: 2067475048 | <2>USED_SPACE1: 0 | <3>USED_SPACE2: 1856202500

Since:

32

See Also:

IBackend.queryFreeSpaceSummary(), QUERY_FREE_SPACE_SUMMARY

Nested Class Summary

static class

IFreeSpaceSummary.Props The properties of an IFreeSpaceSummary response.

Method Summary

Long	getTotalSpace() Gets the total space on file system.
Long	getUsedSpace() Gets the used space on file system.

Methods inherited from interface org.jmythapi.protocol.response.IBasicFreeSpace

getFreeSpace

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

getTotalSpace

Long getTotalSpace()

Gets the total space on file system.

Specified by:

getTotalSpace in interface IBasicFreeSpace

Returns:

total space

See Also:

IFreeSpaceSummary.Props.TOTAL_SPACE

getUsedSpace

Long getUsedSpace()

Gets the used space on file system.

Specified by:

getUsedSpace in interface IBasicFreeSpace

Returns:

used space

See Also:

IFreeSpaceSummary.Props.USED_SPACE