Package jmri
Interface Reportable
-
- All Known Implementing Classes:
AbstractIdTag
,DefaultIdTag
,DefaultRailCom
,TranspondingTag
public interface Reportable
This interface specifies that an object provides a report value suitable for display in an on-screen reporter.
This file is part of JMRI.JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.
JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
- Since:
- 4.15.3
- See Also:
Reporter
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default java.lang.String
toReportString()
Provide a string representation of the object, possibly including state information, suitable for display in an on-screen reporter.
-
-
-
Method Detail
-
toReportString
default java.lang.String toReportString()
Provide a string representation of the object, possibly including state information, suitable for display in an on-screen reporter. A default implementation provided here calls toString(), which may not be appropriate in all cases.- Returns:
- a report string representing the Object.
-
-