|
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 |
java.lang.Objectorg.hyperic.hq.livedata.formatters.ToStringFormatter
public class ToStringFormatter
Constructor Summary | |
---|---|
ToStringFormatter()
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ToStringFormatter()
Method Detail |
---|
public boolean canFormat(LiveDataCommand cmd, FormatType type)
LiveDataFormatter
canFormat
in interface LiveDataFormatter
public java.lang.String format(LiveDataCommand cmd, FormatType type, ConfigResponse formatCfg, java.lang.Object val)
LiveDataFormatter
format
in interface LiveDataFormatter
cmd
- The command that was executedtype
- The type of data for the resultformatCfg
- Configuration for the formatter (a response to
LiveDataFormatter.getConfig(LiveDataCommand)
)val
- The value to formatpublic ConfigSchema getConfig(LiveDataCommand cmd)
LiveDataFormatter
getConfig
in interface LiveDataFormatter
cmd
- The command that will be executed and later formatted.public java.lang.String getDescription()
LiveDataFormatter
getDescription
in interface LiveDataFormatter
public java.lang.String getName()
LiveDataFormatter
getName
in interface LiveDataFormatter
public java.lang.String getId()
LiveDataFormatter
getId
in interface LiveDataFormatter
|
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 |