org.openstreetmap.josm.data
Class CustomConfigurator

java.lang.Object
  extended by org.openstreetmap.josm.data.CustomConfigurator

public class CustomConfigurator
extends java.lang.Object

Class to process configuration changes stored in XML can be used to modify preferences, store/delete files in .josm folders etc


Nested Class Summary
static class CustomConfigurator.PreferencesUtils
          Helper class to do specific Prefrences operation - appending, replacing, deletion by key and by value Also contains functions that convert preferences object to JavaScript object and back
static class CustomConfigurator.XMLCommandProcessor
           
 
Field Summary
private static boolean busy
           
private static java.lang.StringBuilder summary
           
 
Constructor Summary
CustomConfigurator()
           
 
Method Summary
static int askForOption(java.lang.String text, java.lang.String opts)
          Simple function for choose window, may be used from JS API and from other code
static java.lang.String askForText(java.lang.String text)
           
static Preferences clonePreferences(Preferences pref)
           
static void deleteFile(java.lang.String path, java.lang.String base)
           
static void deleteFileOrDirectory(java.io.File f)
           
static void deleteFileOrDirectory(java.lang.String path)
           
static void downloadAndUnpackFile(java.lang.String address, java.lang.String path, java.lang.String base)
          Downloads file to one of JOSM standard folders nad unpack it as ZIP/JAR file
static void downloadFile(java.lang.String address, java.lang.String path, java.lang.String base)
          Downloads file to one of JOSM standard folders
static void exportPreferencesKeysByPatternToFile(java.lang.String fileName, boolean append, java.lang.String pattern)
          This function exports part of user preferences to specified file.
static void exportPreferencesKeysToFile(java.lang.String filename, boolean append, java.util.Collection<java.lang.String> keys)
          Export specified preferences keys to configuration file
static void exportPreferencesKeysToFile(java.lang.String filename, boolean append, java.lang.String... keys)
          This function exports part of user preferences to specified file.
private static java.lang.String getDirectoryByAbbr(java.lang.String base)
           
static java.lang.String getLog()
           
static void log(java.lang.String s)
           
static void log(java.lang.String fmt, java.lang.Object... vars)
           
static void messageBox(java.lang.String type, java.lang.String text)
          Simple function to show messageBox, may be used from JS API and from other code
static void pluginOperation(java.lang.String install, java.lang.String uninstall, java.lang.String delete)
           
static void processDownloadOperation(java.lang.String address, java.lang.String path, java.lang.String parentDir, boolean mkdir, boolean unzip)
          Downloads file to arbitrary folder
static void readXML(java.io.File file)
          Read configuration script from XML file, modifying main preferences
static void readXML(java.io.File file, Preferences prefs)
          Read configuration script from XML file, modifying given preferences object
static void readXML(java.lang.String dir, java.lang.String fileName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

summary

private static java.lang.StringBuilder summary

busy

private static boolean busy
Constructor Detail

CustomConfigurator

public CustomConfigurator()
Method Detail

log

public static void log(java.lang.String fmt,
                       java.lang.Object... vars)

log

public static void log(java.lang.String s)

getLog

public static java.lang.String getLog()

readXML

public static void readXML(java.lang.String dir,
                           java.lang.String fileName)

readXML

public static void readXML(java.io.File file,
                           Preferences prefs)
Read configuration script from XML file, modifying given preferences object

Parameters:
file - - file to open for reading XML
prefs - - arbitrary Preferences object to modify by script

readXML

public static void readXML(java.io.File file)
Read configuration script from XML file, modifying main preferences

Parameters:
file - - file to open for reading XML

downloadFile

public static void downloadFile(java.lang.String address,
                                java.lang.String path,
                                java.lang.String base)
Downloads file to one of JOSM standard folders

Parameters:
address - - URL to download
path - - file path relative to base where to put downloaded file
base - - only "prefs", "cache" and "plugins" allowed for standard folders

downloadAndUnpackFile

public static void downloadAndUnpackFile(java.lang.String address,
                                         java.lang.String path,
                                         java.lang.String base)
Downloads file to one of JOSM standard folders nad unpack it as ZIP/JAR file

Parameters:
address - - URL to download
path - - file path relative to base where to put downloaded file
base - - only "prefs", "cache" and "plugins" allowed for standard folders

processDownloadOperation

public static void processDownloadOperation(java.lang.String address,
                                            java.lang.String path,
                                            java.lang.String parentDir,
                                            boolean mkdir,
                                            boolean unzip)
Downloads file to arbitrary folder

Parameters:
address - - URL to download
path - - file path relative to parentDir where to put downloaded file
parentDir - - folder where to put file
mkdir - - if true, non-existing directories will be created
unzip - - if true file wil be unzipped and deleted after download

messageBox

public static void messageBox(java.lang.String type,
                              java.lang.String text)
Simple function to show messageBox, may be used from JS API and from other code

Parameters:
type - - 'i','w','e','q','p' for Information, Warning, Error, Question, Message
text - - message to display, HTML allowed

askForOption

public static int askForOption(java.lang.String text,
                               java.lang.String opts)
Simple function for choose window, may be used from JS API and from other code

Parameters:
text - - message to show, HTML allowed
opts - -
Returns:
number of pressed button, -1 if cancelled

askForText

public static java.lang.String askForText(java.lang.String text)

exportPreferencesKeysToFile

public static void exportPreferencesKeysToFile(java.lang.String filename,
                                               boolean append,
                                               java.lang.String... keys)
This function exports part of user preferences to specified file. Default values are not saved.

Parameters:
filename - - where to export
append - - if true, resulting file cause appending to exuisting preferences
keys - - which preferences keys you need to export ("imagery.entries", for example)

exportPreferencesKeysByPatternToFile

public static void exportPreferencesKeysByPatternToFile(java.lang.String fileName,
                                                        boolean append,
                                                        java.lang.String pattern)
This function exports part of user preferences to specified file. Default values are not saved. Preference keys matching specified pattern are saved

Parameters:
filename - - where to export
append - - if true, resulting file cause appending to exuisting preferences
pattern - - Regexp pattern forh preferences keys you need to export (".*imagery.*", for example)

exportPreferencesKeysToFile

public static void exportPreferencesKeysToFile(java.lang.String filename,
                                               boolean append,
                                               java.util.Collection<java.lang.String> keys)
Export specified preferences keys to configuration file

Parameters:
filename - - name of file
append - - will the preferences be appended to existing ones when file is imported later. Elsewhere preferences from file will replace existing keys.
keys - - collection of preferences key names to save

deleteFile

public static void deleteFile(java.lang.String path,
                              java.lang.String base)

deleteFileOrDirectory

public static void deleteFileOrDirectory(java.lang.String path)

deleteFileOrDirectory

public static void deleteFileOrDirectory(java.io.File f)

pluginOperation

public static void pluginOperation(java.lang.String install,
                                   java.lang.String uninstall,
                                   java.lang.String delete)

getDirectoryByAbbr

private static java.lang.String getDirectoryByAbbr(java.lang.String base)

clonePreferences

public static Preferences clonePreferences(Preferences pref)


JOSM