io.mats3.localinspect

Class LocalHtmlInspectForMatsFactoryImpl

java.lang.Object

io.mats3.localinspect.LocalHtmlInspectForMatsFactoryImpl

All Implemented Interfaces:

LocalHtmlInspectForMatsFactory

public class LocalHtmlInspectForMatsFactoryImpl
extends java.lang.Object
implements LocalHtmlInspectForMatsFactory

Implementation of LocalHtmlInspectForMatsFactory.

Method Summary

Modifier and Type	Method and Description
static LocalHtmlInspectForMatsFactoryImpl	create(MatsFactory matsFactory) Creates the standard implementation of this interface.
void	createEndpointReport(java.lang.Appendable out, MatsEndpoint<?,?> matsEndpoint, boolean includeStages) Creates the report of a single endpoint.
void	createFactoryReport(java.lang.Appendable out, boolean includeInitiators, boolean includeEndpoints, boolean includeStages) Creates the full MatsFactory HTML report.
void	createFactorySummary(java.lang.Appendable out, boolean includeInitiators, boolean includeEndpoints) Creates the "Summary table" which is a part of the factory report - it may be interesting to embed on a different page without the entire factory report.
void	createInitiatorReport(java.lang.Appendable out, MatsInitiator matsInitiator) Creates the report of a single initiator.
void	createStageReport(java.lang.Appendable out, MatsStage<?,?,?> matsStage) Creates the report of a single stage.
void	getJavaScript(java.lang.Appendable out) Note: The return from this method is static, and should only be included once per HTML page, no matter how many MatsFactories you display.
void	getStyleSheet(java.lang.Appendable out) Note: The return from this method is static, and should only be included once per HTML page, no matter how many MatsFactories you display.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static LocalHtmlInspectForMatsFactoryImpl create(MatsFactory matsFactory)

Description copied from interface: LocalHtmlInspectForMatsFactory

Creates the standard implementation of this interface.

Specified by:

create in interface LocalHtmlInspectForMatsFactory

getStyleSheet

public void getStyleSheet(java.lang.Appendable out)
                   throws java.io.IOException

Note: The return from this method is static, and should only be included once per HTML page, no matter how many MatsFactories you display.

Specified by:

getStyleSheet in interface LocalHtmlInspectForMatsFactory

Throws:

java.io.IOException

getJavaScript

public void getJavaScript(java.lang.Appendable out)
                   throws java.io.IOException

Note: The return from this method is static, and should only be included once per HTML page, no matter how many MatsFactories you display.

Specified by:

getJavaScript in interface LocalHtmlInspectForMatsFactory

Throws:

java.io.IOException

createFactoryReport

public void createFactoryReport(java.lang.Appendable out,
                                boolean includeInitiators,
                                boolean includeEndpoints,
                                boolean includeStages)
                         throws java.io.IOException

Description copied from interface: LocalHtmlInspectForMatsFactory

Creates the full MatsFactory HTML report.

Specified by:

createFactoryReport in interface LocalHtmlInspectForMatsFactory

Parameters:

out - where to output the HTML

includeInitiators - whether to include the initiators in the report

includeEndpoints - whether to include the endpoints in the report

includeStages - whether to include the stages of the endpoints in the report

Throws:

java.io.IOException - if the Appendable throws while being output to.

createFactorySummary

public void createFactorySummary(java.lang.Appendable out,
                                 boolean includeInitiators,
                                 boolean includeEndpoints)
                          throws java.io.IOException

Description copied from interface: LocalHtmlInspectForMatsFactory

Creates the "Summary table" which is a part of the factory report - it may be interesting to embed on a different page without the entire factory report.

Specified by:

createFactorySummary in interface LocalHtmlInspectForMatsFactory

Parameters:

out - where to output the HTML

includeInitiators - whether to include the initiators in the report

includeEndpoints - whether to include the endpoints in the report

Throws:

java.io.IOException - if the Appendable throws while being output to.

createInitiatorReport

public void createInitiatorReport(java.lang.Appendable out,
                                  MatsInitiator matsInitiator)
                           throws java.io.IOException

Description copied from interface: LocalHtmlInspectForMatsFactory

Creates the report of a single initiator.

Specified by:

createInitiatorReport in interface LocalHtmlInspectForMatsFactory

Throws:

java.io.IOException

createEndpointReport

public void createEndpointReport(java.lang.Appendable out,
                                 MatsEndpoint<?,?> matsEndpoint,
                                 boolean includeStages)
                          throws java.io.IOException

Description copied from interface: LocalHtmlInspectForMatsFactory

Creates the report of a single endpoint.

Specified by:

createEndpointReport in interface LocalHtmlInspectForMatsFactory

Throws:

java.io.IOException

createStageReport

public void createStageReport(java.lang.Appendable out,
                              MatsStage<?,?,?> matsStage)
                       throws java.io.IOException

Description copied from interface: LocalHtmlInspectForMatsFactory

Creates the report of a single stage.

Specified by:

createStageReport in interface LocalHtmlInspectForMatsFactory

Throws:

java.io.IOException