org.openstreetmap.josm.gui.tagging.presets

Class TaggingPresetReader

java.lang.Object

org.openstreetmap.josm.gui.tagging.presets.TaggingPresetReader

public final class TaggingPresetReader
extends java.lang.Object

The tagging presets reader.

Since:

6068

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaggingPresetReader.Chunk Holds a reference to a chunk of items/objects.
(package private) static class	TaggingPresetReader.HashSetWithLast<E>
static class	TaggingPresetReader.Reference Holds a reference to an earlier item/object.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	loadIcons
static java.lang.String	PRESET_MIME_TYPES The accepted MIME types sent in the HTTP Accept header.
private static java.io.File	zipIcons

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TaggingPresetReader()

Method Summary

Modifier and Type	Method and Description
private static XmlObjectParser	buildParser()
static java.util.Set<java.lang.String>	getPresetSources() Returns the set of preset source URLs.
static java.io.File	getZipIcons()
static boolean	isLoadIcons() Determines if icon images should be loaded.
static java.util.Collection<TaggingPreset>	readAll(java.util.Collection<java.lang.String> sources, boolean validate) Reads all tagging presets from the given sources.
static java.util.Collection<TaggingPreset>	readAll(java.util.Collection<java.lang.String> sources, boolean validate, boolean displayErrMsg) Reads all tagging presets from the given sources.
static java.util.Collection<TaggingPreset>	readAll(java.io.Reader in, boolean validate) Reads all tagging presets from the input reader.
(package private) static java.util.Collection<TaggingPreset>	readAll(java.io.Reader in, boolean validate, TaggingPresetReader.HashSetWithLast<TaggingPreset> all) Reads all tagging presets from the input reader.
static java.util.Collection<TaggingPreset>	readAll(java.lang.String source, boolean validate) Reads all tagging presets from the given source.
(package private) static java.util.Collection<TaggingPreset>	readAll(java.lang.String source, boolean validate, TaggingPresetReader.HashSetWithLast<TaggingPreset> all) Reads all tagging presets from the given source.
static java.util.Collection<TaggingPreset>	readFromPreferences(boolean validate, boolean displayErrMsg) Reads all tagging presets from sources stored in preferences.
static void	setLoadIcons(boolean loadIcons) Sets whether icon images should be loaded.

Methods inherited from class java.lang.Object

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

Field Detail

PRESET_MIME_TYPES

public static final java.lang.String PRESET_MIME_TYPES

The accepted MIME types sent in the HTTP Accept header.

Since:

6867

See Also:

Constant Field Values

zipIcons

private static volatile java.io.File zipIcons

loadIcons

private static volatile boolean loadIcons

Constructor Detail

TaggingPresetReader

private TaggingPresetReader()

Method Detail

getPresetSources

public static java.util.Set<java.lang.String> getPresetSources()

Returns the set of preset source URLs.

Returns:

The set of preset source URLs.

buildParser

private static XmlObjectParser buildParser()

readAll

public static java.util.Collection<TaggingPreset> readAll(java.io.Reader in,
                                                          boolean validate)
                                                   throws org.xml.sax.SAXException

Reads all tagging presets from the input reader.

Parameters:

in - The input reader

validate - if true, XML validation will be performed

Returns:

collection of tagging presets

Throws:

org.xml.sax.SAXException - if any XML error occurs

readAll

static java.util.Collection<TaggingPreset> readAll(java.io.Reader in,
                                                   boolean validate,
                                                   TaggingPresetReader.HashSetWithLast<TaggingPreset> all)
                                            throws org.xml.sax.SAXException

Reads all tagging presets from the input reader.

Parameters:

in - The input reader

validate - if true, XML validation will be performed

all - the accumulator for parsed tagging presets

Returns:

the accumulator

Throws:

org.xml.sax.SAXException - if any XML error occurs

readAll

public static java.util.Collection<TaggingPreset> readAll(java.lang.String source,
                                                          boolean validate)
                                                   throws org.xml.sax.SAXException,
                                                          java.io.IOException

Reads all tagging presets from the given source.

Parameters:

source - a given filename, URL or internal resource

validate - if true, XML validation will be performed

Returns:

collection of tagging presets

Throws:

org.xml.sax.SAXException - if any XML error occurs

java.io.IOException - if any I/O error occurs

readAll

static java.util.Collection<TaggingPreset> readAll(java.lang.String source,
                                                   boolean validate,
                                                   TaggingPresetReader.HashSetWithLast<TaggingPreset> all)
                                            throws org.xml.sax.SAXException,
                                                   java.io.IOException

Reads all tagging presets from the given source.

Parameters:

source - a given filename, URL or internal resource

validate - if true, XML validation will be performed

all - the accumulator for parsed tagging presets

Returns:

the accumulator

Throws:

org.xml.sax.SAXException - if any XML error occurs

java.io.IOException - if any I/O error occurs

readAll

public static java.util.Collection<TaggingPreset> readAll(java.util.Collection<java.lang.String> sources,
                                                          boolean validate)

Reads all tagging presets from the given sources.

Parameters:

sources - Collection of tagging presets sources.

validate - if true, presets will be validated against XML schema

Returns:

Collection of all presets successfully read

readAll

public static java.util.Collection<TaggingPreset> readAll(java.util.Collection<java.lang.String> sources,
                                                          boolean validate,
                                                          boolean displayErrMsg)

Reads all tagging presets from the given sources.

Parameters:

sources - Collection of tagging presets sources.

validate - if true, presets will be validated against XML schema

displayErrMsg - if true, a blocking error message is displayed in case of I/O exception.

Returns:

Collection of all presets successfully read

readFromPreferences

public static java.util.Collection<TaggingPreset> readFromPreferences(boolean validate,
                                                                      boolean displayErrMsg)

Reads all tagging presets from sources stored in preferences.

Parameters:

validate - if true, presets will be validated against XML schema

displayErrMsg - if true, a blocking error message is displayed in case of I/O exception.

Returns:

Collection of all presets successfully read

getZipIcons

public static java.io.File getZipIcons()

isLoadIcons

public static boolean isLoadIcons()

Determines if icon images should be loaded.

Returns:

true if icon images should be loaded

setLoadIcons

public static void setLoadIcons(boolean loadIcons)

Sets whether icon images should be loaded.

Parameters:

loadIcons - true if icon images should be loaded