Package org.openstreetmap.josm.tools

Provides the classes for various utilities and tools called from all other packages.

Interface Summary

Interface	Description
Destroyable	Some objects like layers (when they are removed) or the whole map frame (when the last layer has been removed) have a definite set of actions to execute.
Diff.ScriptBuilder	Script builder.
GeoProperty<T>	A method to look up a property of the earth surface.
HttpClient.ConnectionResponse	A wrapper for the HTTP connection response.
HttpClient.HttpClientFactory	HTTP client factory.
ImageProcessor	Processor that modifies images (sharpen, brightness, etc.).
ImageWarp.PointTransform	Transformation that translates the pixel coordinates.
ListenerList.EventFirerer<T>	This is a function that can be invoked for every listener.
MemoryManager.MemoryHandle<T>	A memory area managed by the MemoryManager.
OptionParser.AvailableOption
PlatformHook	This interface allows platform (operating system) dependent code to be bundled into self-contained classes.
PlatformHook.JavaExpirationCallback	Called when an outdated version of Java is detected at startup.
PlatformHook.NativeOsCallback	Called when interfacing with native OS functions.
PlatformHook.SanityCheckCallback	Inform the user that a sanity check or checks failed
PlatformVisitor<T>	Visitor, to be used with Platform.
Property<O,P>	Small interface to define a property with both read and write access.
RotationAngle	Determines how an icon is to be rotated depending on the primitive to be displayed.
Tag2Link.LinkConsumer	Represents an operation that accepts a link.
TextTagParser.TagWarningCallback	Called when a problematic tag is encountered.

Class Summary

Class	Description
AlphanumComparator	The Alphanum Algorithm is an improved sorting algorithm for strings containing numbers: Instead of sorting numbers in ASCII order like a standard sort, this algorithm sorts numbers in numeric order.
CheckParameterUtil	This utility class provides a collection of static helper methods for checking parameters at run-time.
ColorHelper	Helper to convert from color to HTML string and back.
ColorScale	Utility class that helps to work with color scale for coloring GPX tracks etc.
CompositeList<T>	Joined List build from two Lists (read-only).
CopyList<E>	A List implementation initially based on given array, but never modifying the array directly.
DefaultGeoProperty	Implementation of simple boolean GeoProperty.
Diff	A class to compare vectors of objects.
Diff.Change	The result of comparison is an "edit script": a chain of change objects.
Diff.ForwardScript
Diff.ReverseScript	Scan the tables of which lines are inserted and deleted, producing an edit script in reverse order.
ExceptionUtil	Utilities for exception handling.
ExifReader	Read out EXIF information from a JPEG file
FontsManager	Custom fonts manager that provides some embedded fonts to ensure a common rendering on different platforms.
GBC	A wrapper for GridBagConstraints which has sane default static creators and member functions to chain calling.
GenericParser<U>	Utility class to parse various types from other values.
Geometry	Some tools for geometry related tasks.
Geometry.AreaAndPerimeter	Data class to hold two double values (area and perimeter of a polygon).
GeoPropertyIndex<T>	Fast index to look up properties of the earth surface.
GeoPropertyIndex.GPLevel<T>
GeoUrlToBounds	Parses a Geo URL (as specified in RFC 5870) into Bounds.
GuiSizesHelper	Support class to handle size information of Gui elements This is needed, because display resolution may vary a lot and a common set of sizes won't work for all users alike.
HiDPISupport	Helper class for HiDPI support.
Http1Client	Provides a uniform access for a HTTP/HTTPS 1.0/1.1 server.
Http1Client.Http1Response	A wrapper for the HTTP 1.x response.
HttpClient	Provides uniform access for a HTTP/HTTPS server.
HttpClient.Response	A wrapper for the HTTP response.
I18n	Internationalisation support.
ImageOverlay	class to describe how image overlay
ImageProvider	Helper class to support the application with images.
ImageResource	Holds data for one particular image.
ImageWarp	Image warping algorithm.
ImageWarp.GridTransform	Wrapper that optimizes a given ImageWarp.PointTransform.
InputMapUtils	Tools to work with Swing InputMap.
JosmDecimalFormatSymbolsProvider	JOSM implementation of the DecimalFormatSymbols class, consistent with ISO 80000-1.
KeyboardUtils	Keyboard utils.
LanguageInfo	This is a utility class that provides information about locales and allows to convert locale codes.
ListenableWeakReference<T>	This is a special weak reference that notifies a listener when it is no longer available.
ListenerList<T>	This is a list of listeners.
ListenerList.TracingListenerList<T>	This is a special ListenerList that traces calls to the add/remove methods.
ListenerList.UncheckedListenerList<T>
ListenerList.WeakListener<T>
ListeningCollection<T>	This is a proxy of a collection that notifies a listener on every collection change
Logging	This class contains utility methods to log errors and warnings.
Logging.ReacquiringConsoleHandler	A ConsoleHandler with a couple of extra features, allowing it to be targeted at an an arbitrary OutputStream which it can be asked to reacquire the reference for on demand through Logging.ReacquiringConsoleHandler.reacquireOutputStream().
Logging.RememberWarningHandler
Mediawiki	Interaction with Mediawiki instances, such as the OSM wiki.
MemoryManager	This class allows all components of JOSM to register reclaimable amounts to memory.
MultiMap<A,B>	MultiMap - maps keys to multiple values.
OpenBrowser	Helper to open platform web browser on different platforms This now delegates the real work to a platform specific class.
OptionParser	A replacement of getopt.
OptionParser.FoundOption
OsmPrimitiveImageProvider	An ImageProvider for OsmPrimitive
OsmUrlToBounds	Parses various URL used in OpenStreetMap projects into Bounds.
Pair<A,B>	A pair of objects.
PatternUtils	A class that caches compiled patterns.
PlatformHookOsx	PlatformHook implementation for Apple macOS (formerly Mac OS X) systems.
PlatformHookUnixoid	PlatformHook implementation for Unix systems.
PlatformHookUnixoid.LinuxReleaseInfo
PlatformHookWindows	PlatformHook implementation for Microsoft Windows systems.
PlatformHookWindows.FontEntry	Simple data class to hold information about a font.
PlatformManager	Holder for current platform hook.
ReflectionUtils	Reflection utilities.
ResourceProvider	Unified provider that looks up for resource in various classloaders (josm, plugins, etc.).
RightAndLefthandTraffic	Look up, if there is right- or left-hand traffic at a certain place.
RotationAngle.StaticRotationAngle	A static rotation
RotationAngle.WayDirectionRotationAngle	The rotation along a way.
SearchCompilerQueryWizard	Builds an Overpass QL from a SearchAction query.
ShapeClipper	Tools to clip a shape based on the Sutherland-Hodgman algorithm.
Shortcut	Global shortcut class.
Shortcut.ShortcutCollection
Stopwatch	Measures elapsed time in milliseconds
StreamUtils	Utility methods for streams.
StringParser	Utility class to parse various types from strings.
SubclassFilteredCollection<S,T extends S>	Filtered view of a collection.
Tag2Link	Extracts web links from OSM tags.
TaginfoRegionalInstance	Describes a regional Taginfo instance.
Territories	Look up territories ISO3166 codes at a certain place.
TextAnalyzer	A helper class that analyzes the text and attempts to parse tags from it
TextTagParser	Class that helps to parse tags from arbitrary text
TextUtils	Text/String utils.
Utils	Basic utils, that can be useful in different parts of the program.
Utils.DirectionString	Utility class to save a string along with its rendering direction (left-to-right or right-to-left).
Utils.JosmForkJoinWorkerThread	A ForkJoinWorkerThread that will always inherit caller permissions, unlike JDK's InnocuousForkJoinWorkerThread, used if a security manager exists.
WikiReader	Read a trac-wiki page.
WindowsShortcut	Represents a Windows shortcut (typically visible to Java only as a '.lnk' file).
WinRegistry	Utility class to access Window registry (read access only).
XmlObjectParser	An helper class that reads from a XML stream into specific objects.
XmlObjectParser.AddNamespaceFilter
XmlObjectParser.Entry
XmlUtils	XML utils, mainly used to construct safe factories.

Enum Summary

Enum	Description
Geometry.PolygonIntersection	The result types for a Geometry.polygonIntersection(Area, Area) test
I18n.PluralMode	Enumeration of possible plural modes.
ImageProvider.ImageSizes	Supported image sizes
ImageProvider.ImageType	Supported image types
ImageResizeMode	Determines how the image is sized/resized in ImageResource.getImageIcon(Dimension, boolean, ImageResizeMode).
ImageWarp.Interpolation	Interpolation method.
LanguageInfo.LocaleType	Type of the locale to use
OptionParser.OptionCount	How often an option may / must be specified on the command line.
OsmPrimitiveImageProvider.Options	Options used in OsmPrimitiveImageProvider.getResource(OsmPrimitive, Collection).
Platform	Enum listing the supported platforms (operating system families).

Exception Summary

Exception	Description
JosmRuntimeException	JOSM runtime exception.
MemoryManager.NotEnoughMemoryException	This exception is thrown if there is not enough memory for allocating the given object.
OptionParser.OptionParseException	Exception thrown when an option cannot be parsed.
SAXReturnException	Quit parsing, when a certain condition is met
UncheckedParseException	Signals that an error has been reached unexpectedly while parsing.
UserCancelException	Exception thrown when an operation is canceled by user.
XmlParsingException	An exception thrown during XML parsing, with known line and column.

Annotation Types Summary

Annotation Type	Description
I18n.QuirkyPluralString	This annotates strings which do not permit a clean i18n.