@DefaultAnnotation({})

Package jmri.util

Contains various utilities classes that are useful across the entire JMRI library structure.

Please put new classes into appropriate subpackage, i.e. for jmri.util.swing for Swing/AWT related utilities, etc.

The jmri.util.com package contains several sets of imported code.

Interface Summary

Interface	Description
HelpUtil.MenuProvider
ThreadingUtil.ReturningThreadAction<E>	Interface for use in ThreadingUtil's lambda interfaces
ThreadingUtil.ThreadAction	Interface for use in ThreadingUtil's lambda interfaces
ThreadingUtil.ThreadActionWithJmriException	Interface for use in ThreadingUtil's lambda interfaces

Class Summary

Class	Description
AbstractFrameAction	Swing action that defers class loading until invoked.
AlphanumComparator	This is an updated version with enhancements made by Daniel Migowski, Andre Bogus, and David Koelle
ArrayUtil	Useful array methods.
Bundle
BusyGlassPane	Used to intercept inputs and to display a busy cursor during reads and writes.
BusyGlassPane.CBListener	Listen for all events that our components are likely to be interested in.
ColorUtil	A collection of utilities related to colors.
CompareUtil	Compare values.
ConnectionNameFromSystemName	Common utility method for returning the System Connection Name from the System Name Prefix
CvUtil	Common utility methods for working with CVs
DateUtil	Common utility methods for working with Calendar and Date objects.
DnDStringImportHandler	Simple TransferHandler that overwrites the text in a JTextField component.
DnDTableExportHandler
DnDTableImportExportHandler	Simple TransferHandler that imports and exports Strings into JTable cells.
EarlyInitializationPreferences	Allow the user to configure properties that needs to be setup very early when JMRI starts, for example before Swing starts up.
FileUtil	Common utility methods for working with Files.
FileUtil.Property	PropertyChangeEvents for properties that are Profile-specific use a Property to enclose both the Profile and the value of the property.
FileUtilSupport	Support the FileUtil static API while providing PropertyChangeSupport for listening to changes in the paths.
GetJavaProperty	Print a Java system variable from the command line.
HelpUtil	Common utility methods for displaying JMRI help pages.
HelpUtilPreferences	Preferences for HelpUtil
HelpUtilPreferencesPanel	Preferences panel for HelpUtil
ImmediatePipedOutputStream	Makes a workaround for standard PipedOutputStream wait.
IntlUtilities	Common utility methods for Internationalization (I18N) and Localization (L12N) in the default Locale.
IterableEnumeration<T>	Provide an Iterable interface for an Enumeration
JmriInsets	This class attempts to retrieve the screen insets for all operating systems.
JmriJFrame	JFrame extended for common JMRI use.
JmriJFrame.ScreenDimensions	Represents the dimensions of an attached screen/display
JmriJFrameAction	Default form of action to create an object that's from a child class of JmriJFrame.
JmriLocalEntityResolver	Entity Resolver to locate JMRI DTDs in the local space.
JmriNullEntityResolver	Return a content-less DTD
JmriThreadPoolExecutor
JTreeWithPopup	JTree subclass that supports a popup menu.
LocoAddressComparator	Comparator for LocoAddress objects.
LoggingUtil	Basic utilities for logging special messages.
MathUtil	Useful math methods.
MenuScroller	A class that provides scrolling capabilities to a long menu dropdown or popup menu.
MouseInputAdapterInstaller	A Visitor class for installing a MouseInputAdapter on a container and all of its subcomponents.
MultipartMessage	Sends multi-part HTTP POST requests to a web server
NamedBeanComparator<B extends NamedBean>	Comparator for JMRI NamedBeans via their System Names.
NamedBeanExpectedState<T extends NamedBean>	Retain a NamedBean and its expected state.
NamedBeanExpectedValue<T extends NamedBean,S>	Retain a NamedBean and its expected value (called a state in this class).
NamedBeanHandleComparator<H extends NamedBeanHandle<? extends NamedBean>>	Comparator for JMRI NamedBeanHandle of NamedBeans via their System Names.
NamedBeanPreferNumericComparator<B extends NamedBean>	Compare two NamedBeans using the PreferNumericComparator against NamedBean.getSystemName() for each NamedBean.
NamedBeanUserNameComparator<B extends NamedBean>	Comparator for JMRI NamedBeans via their User Names.
NoArchiveFileFilter	File filter to suppress zip file archives.
NonNullArrayList<E>	An ArrayList that SpotBugs understands will never contain null elements.
OrderedProperties	Properties implementation that enumerates properties sorted by key.
PhysicalLocation	PhysicalLocation Represents a physical location on the layout in 3D space.
PhysicalLocationPanel	Provides a Swing component to show and/or edit a PhysicalLocation This file is part of JMRI.
PipeListener	Small service class to read characters from a pipe and post them to a JTextArea for display.
PlaceWindow	Position a Window relative to a component in another window so as to not obscure a component in that window.
PortNameMapper	Class used to provide a mapping between port numbers and 'friendly' names, aimed at users of Microsoft Windows.
PortNameMapper.SerialPortFriendlyName
PreferNumericComparator	Perform an comparison using AlphanumComparator, followed up with a standard String comparison if AlphanumComparator.compare(String, String) returns 0.
PropertyChangeEventQueue	Gathers PropertyChangeEvents that might occur in overlapping threads and at overlapping times, presenting them as requested.
QuickPromptUtil	A collection of utilities related to prompting for values
QuickPromptUtil.FloatRangePredicate
QuickPromptUtil.IntRangePredicate
StringUtil	Common utility methods for working with Strings.
SystemType	Common utility methods for determining which type of operating system is in use.
ThreadingUtil	Utilities for handling JMRI's threading conventions.
TimerUtil	Common utility methods for working with (@link java.util.Timer)
TypeConversionUtil	Converts between java types, for example String to Double and double to boolean.
UnzipFileClass	Unzip a local file or URL to into a specified directory
ValidatingInputPane<T>	A helper Panel for input-validating input boxes.
WaitHandler	Common utility class for handling the "spurious wakeup from wait()" problem documented in Object.wait(long).
WindowMenu	Creates a menu showing all open windows and allows to bring one in front
XmlFilenameFilter	Filter for filenames ending in .xml.

Enum Summary

Enum	Description
CompareUtil.CompareOperation
CompareUtil.CompareType
FileUtil.Location	The types of locations to use when falling back on default locations in FileUtil.findURI(java.lang.String, jmri.util.FileUtil.Location, java.lang.String...).