Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.hq.livedata
Interface LiveDataFormatter

All Known Implementing Classes:
CpuInfoFormatter, CpuPercFormatter, DfFormatter, IfconfigFormatter, NetstatFormatter, TopFormatter, ToStringFormatter, WhoFormatter

public interface LiveDataFormatter

Implementations of this interface are able to convert objects returned from LiveData commands into strings, suitable for display.


Method Summary
 boolean canFormat(LiveDataCommand cmd, FormatType type)
          Return true if the formatter can format the specified command.
 java.lang.String format(LiveDataCommand cmd, FormatType type, ConfigResponse formatCfg, java.lang.Object val)
          Format a result from a LiveData execution into a string
 ConfigSchema getConfig(LiveDataCommand cmd)
          Get configuration parameters used to pass to format()
 java.lang.String getDescription()
          Get the description of the formatter
 java.lang.String getId()
          Get a simple string which uniquely identifies this formatter.
 java.lang.String getName()
          Get the name of the formatter, used for display purposes.
 

Method Detail

format

java.lang.String format(LiveDataCommand cmd,
                        FormatType type,
                        ConfigResponse formatCfg,
                        java.lang.Object val)
Format a result from a LiveData execution into a string

Parameters:
cmd - The command that was executed
type - The type of data for the result
formatCfg - Configuration for the formatter (a response to getConfig(LiveDataCommand))
val - The value to format

getConfig

ConfigSchema getConfig(LiveDataCommand cmd)
Get configuration parameters used to pass to format()

Parameters:
cmd - The command that will be executed and later formatted.

canFormat

boolean canFormat(LiveDataCommand cmd,
                  FormatType type)
Return true if the formatter can format the specified command.


getId

java.lang.String getId()
Get a simple string which uniquely identifies this formatter. E.x. "cpuPerc"


getName

java.lang.String getName()
Get the name of the formatter, used for display purposes.


getDescription

java.lang.String getDescription()
Get the description of the formatter


Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.