de.sciss.syntaxpane.util

Class JarServiceProvider

java.lang.Object

de.sciss.syntaxpane.util.JarServiceProvider

public class JarServiceProvider
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERVICES_ROOT

Method Summary

Modifier and Type	Method and Description
static java.io.InputStream	findResource(java.lang.String url) Attempts to find a location url.
static java.io.InputStream	findResource(java.lang.String url, java.lang.ClassLoader cl) Attempts to find a location url.
static java.util.List<java.lang.Object>	getServiceProviders(java.lang.Class cls) Returns an Object array from the file in META-INF/resources/{classname}
static java.util.List<java.lang.String>	readLines(java.lang.String url) Read the given URL and returns a List of Strings for each input line Each line will not have the line terminator.
static java.util.Properties	readProperties(java.lang.Class clazz) Reads a file in the META-INF/services location.
static java.util.Properties	readProperties(java.lang.String name) Reads a file in the META-INF/services named name appended with ".properties" If no file is found, then a an empty Property instance will be returned
static java.util.Properties	readProperties(java.lang.String name, java.util.Locale locale) Reads language specific files in the META-INF/services named name appended with ".properties".
static java.util.Map<java.lang.String,java.lang.String>	readStringsMap(java.lang.String name) Read a file in the META-INF/services named name appended with ".properties", and returns it as a Map<String, String> If no file is found, then a an empty Property instance will be returned

Methods inherited from class java.lang.Object

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

Field Detail

SERVICES_ROOT

public static final java.lang.String SERVICES_ROOT

See Also:

Constant Field Values

Method Detail

getServiceProviders

public static java.util.List<java.lang.Object> getServiceProviders(java.lang.Class cls)
                                                            throws java.io.IOException

Returns an Object array from the file in META-INF/resources/{classname}

Throws:

java.io.IOException

readProperties

public static java.util.Properties readProperties(java.lang.Class clazz)

Reads a file in the META-INF/services location. File name will be fully qualified classname, in all lower-case, appended with ".properties" If no file is found, then a an empty Property instance will be returned

Returns:

Property file read.

readProperties

public static java.util.Properties readProperties(java.lang.String name)

Reads a file in the META-INF/services named name appended with ".properties" If no file is found, then a an empty Property instance will be returned

Parameters:

name - name of file (use dots to separate subfolders).

Returns:

Property file read.

readProperties

public static java.util.Properties readProperties(java.lang.String name,
                                                  java.util.Locale locale)

Reads language specific files in the META-INF/services named name appended with ".properties". The contents of the files are merged as follows:

• First the default language file (<name>.properties) is read
• Then the general language variant of the file (<name>_<lang>.properties) is read and its entries are added to/overwrite the entries of the default life
• Last the country specific language variant of the file (<name>_<lang>_<country>.properties) is read and its entries are added to/overwrite the existing entries

Example: You have three files:

• config.properties which contains the complete configuration (most likely with English menus, tooltips)
• config_de.properties which only contains menu names and tooltips in German language
• config_de_CH which might just contain entries for specific Swiss spelling variant of some words in a tooltip

If no file is found, then a an empty Property instance will be returned

Parameters:

name - name of file (use dots to separate subfolders).

locale - The locale for which to read the files

Returns:

Property file read.

readStringsMap

public static java.util.Map<java.lang.String,java.lang.String> readStringsMap(java.lang.String name)

Read a file in the META-INF/services named name appended with ".properties", and returns it as a Map<String, String> If no file is found, then a an empty Property instance will be returned

Parameters:

name - name of file (use dots to separate subfolders).

Returns:

Map of keys and values

readLines

public static java.util.List<java.lang.String> readLines(java.lang.String url)

Read the given URL and returns a List of Strings for each input line Each line will not have the line terminator. The resource is searched in /META-INF/services/url, then in url, then the url is treated as a location in the current classpath and an attempt to read it from that location is done.

Parameters:

url - location of file to read

Returns:

List of Strings for each line read. or EMPTY_LIST if URL is not found

findResource

public static java.io.InputStream findResource(java.lang.String url,
                                               java.lang.ClassLoader cl)

Attempts to find a location url. The following locations are searched in sequence: url, SERVICES_ROOT/url all classpath/url

Returns:

InputStream at that location, or null if not found

See Also:

findResource(java.lang.String)

findResource

public static java.io.InputStream findResource(java.lang.String url)

Attempts to find a location url. The following locations are searched in sequence: url, SERVICES_ROOT/url all classpath/url The System ClassLoader is used.

Returns:

InputSTream at that location, or null if not found

See Also:

findResource(java.lang.String, java.lang.ClassLoader)