|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
java.lang.String format(LiveDataCommand cmd, FormatType type, ConfigResponse formatCfg, java.lang.Object val)
cmd
- The command that was executedtype
- The type of data for the resultformatCfg
- Configuration for the formatter (a response to
getConfig(LiveDataCommand)
)val
- The value to formatConfigSchema getConfig(LiveDataCommand cmd)
cmd
- The command that will be executed and later formatted.boolean canFormat(LiveDataCommand cmd, FormatType type)
java.lang.String getId()
java.lang.String getName()
java.lang.String getDescription()
|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |