Package jmri

Class NamedBeanUsageReport

java.lang.Object

jmri.NamedBeanUsageReport

@Immutable
public class NamedBeanUsageReport
extends java.lang.Object

This is a data structure to pass usage information from getUsageReport() requests back to the calling object.

Field Summary

Fields

Modifier and Type	Field	Description
NamedBean	usageBean
java.lang.String	usageData
java.lang.String	usageKey

Constructor Summary

Constructors

Constructor	Description
NamedBeanUsageReport(java.lang.String usageKey)	Create report with the required key.
NamedBeanUsageReport(java.lang.String usageKey, java.lang.String usageData)	Create report with the required key and additional data.
NamedBeanUsageReport(java.lang.String usageKey, NamedBean usageBean)	Create report with the required key and a bean.
NamedBeanUsageReport(java.lang.String usageKey, NamedBean usageBean, java.lang.String usageData)	Create a usage report.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

usageKey

public final java.lang.String usageKey

usageBean

public final NamedBean usageBean

usageData

public final java.lang.String usageData

Constructor Detail

NamedBeanUsageReport

public NamedBeanUsageReport(@Nonnull
                            java.lang.String usageKey)

Create report with the required key.

Parameters:

usageKey - Identifies the report type. Used to control result.

NamedBeanUsageReport

public NamedBeanUsageReport(@Nonnull
                            java.lang.String usageKey,
                            NamedBean usageBean)

Create report with the required key and a bean.

Parameters:

usageKey - Identifies the report type. Used to control result.

usageBean - Identifies a related bean such as SML destination mast. Can be null.

NamedBeanUsageReport

public NamedBeanUsageReport(@Nonnull
                            java.lang.String usageKey,
                            java.lang.String usageData)

Create report with the required key and additional data.

Parameters:

usageKey - Identifies the report type. Used to control result.

usageData - Optional additional data.

NamedBeanUsageReport

public NamedBeanUsageReport(@Nonnull
                            java.lang.String usageKey,
                            NamedBean usageBean,
                            java.lang.String usageData)

Create a usage report.

Parameters:

usageKey - Identifies the report type. Used to control result processing. Might also be used as a bundle key.

usageBean - Identifies a related bean such as SML destination mast. Can be null.

usageData - Optional additional data.