Class TextSystemReportFormatter
- java.lang.Object
-
- org.opennms.systemreport.formatters.AbstractSystemReportFormatter
-
- org.opennms.systemreport.formatters.TextSystemReportFormatter
-
- All Implemented Interfaces:
Comparable<SystemReportFormatter>
,SystemReportFormatter
public class TextSystemReportFormatter extends AbstractSystemReportFormatter implements SystemReportFormatter
-
-
Field Summary
-
Fields inherited from class org.opennms.systemreport.formatters.AbstractSystemReportFormatter
m_outputStream
-
-
Constructor Summary
Constructors Constructor Description TextSystemReportFormatter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canStdout()
Whether this formatter should be allowed to write to STDOUT.String
getContentType()
The Content-Type that this formatter outputs.String
getDescription()
A short description of the format.String
getExtension()
The default extension to use when creating files if no output is specified.String
getName()
A short name for this format for use by UIs when presenting an option of which formatter to choose.void
write(SystemReportPlugin plugin)
Write the data from the specifiedSystemReportPlugin
.-
Methods inherited from class org.opennms.systemreport.formatters.AbstractSystemReportFormatter
begin, compareTo, end, getOutput, getOutputStream, getResourceText, needsOutputStream, setOutput, setOutputStream
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.Comparable
compareTo
-
Methods inherited from interface org.opennms.systemreport.SystemReportFormatter
begin, end, needsOutputStream, setOutput, setOutputStream
-
-
-
-
Method Detail
-
getName
public String getName()
Description copied from interface:SystemReportFormatter
A short name for this format for use by UIs when presenting an option of which formatter to choose.- Specified by:
getName
in interfaceSystemReportFormatter
- Overrides:
getName
in classAbstractSystemReportFormatter
- Returns:
- the format name (eg, "text", "xml", etc.)
-
getDescription
public String getDescription()
Description copied from interface:SystemReportFormatter
A short description of the format.- Specified by:
getDescription
in interfaceSystemReportFormatter
- Overrides:
getDescription
in classAbstractSystemReportFormatter
- Returns:
- the description
-
getContentType
public String getContentType()
Description copied from interface:SystemReportFormatter
The Content-Type that this formatter outputs. This can be null if the formatter does not produce a file (like the FtpSystemReportFormatter).- Specified by:
getContentType
in interfaceSystemReportFormatter
- Returns:
- the content-type the formatter writes.
-
getExtension
public String getExtension()
Description copied from interface:SystemReportFormatter
The default extension to use when creating files if no output is specified.- Specified by:
getExtension
in interfaceSystemReportFormatter
- Returns:
- the extension
-
canStdout
public boolean canStdout()
Description copied from interface:SystemReportFormatter
Whether this formatter should be allowed to write to STDOUT.- Specified by:
canStdout
in interfaceSystemReportFormatter
-
write
public void write(SystemReportPlugin plugin)
Description copied from interface:SystemReportFormatter
Write the data from the specifiedSystemReportPlugin
.- Specified by:
write
in interfaceSystemReportFormatter
- Overrides:
write
in classAbstractSystemReportFormatter
- Parameters:
plugin
- the system report plugin which contains the data to write
-
-