com.izforge.izpack.api.resource

Interface Resources

public interface Resources

IzPack resources.

Author:

Tim Anderson

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM_ICONS_RESOURCE_NAME The base name of the XML file that specifies the custom icons.
static String	CUSTOM_TRANSLATIONS_RESOURCE_NAME The base name of the XML file that specifies the custom langpack.
static String	DEFAULT_INSTALL_LOGGING_CONFIGURATION_RES The install Java logging configuration.
static String	PACK_TRANSLATIONS_RESOURCE_NAME The base name of the XML file that specifies the pack langpack.
static String	USER_INPUT_TRANSLATIONS_RESOURCE_NAME The base name of the XML file that specifies the User Input langpack.

Method Summary

Modifier and Type	Method and Description
ImageIcon	getImageIcon(String name, String... alternatives) Returns an ImageIcon resource.
InputStream	getInputStream(String name) Returns the stream to a resource.
Object	getObject(String name) Returns an object resource.
String	getString(String name) Returns a UTF-8 encoded resource as a string.
String	getString(String name, String defaultValue) Returns a UTF-8 encoded resource as a string.
String	getString(String name, String encoding, String defaultValue) Returns a resource as a string.
URL	getURL(String name) Returns the URL to a resource.

Field Detail

CUSTOM_TRANSLATIONS_RESOURCE_NAME

static final String CUSTOM_TRANSLATIONS_RESOURCE_NAME

The base name of the XML file that specifies the custom langpack. Searched is for the file with the name expanded by _ISO3.

See Also:

Constant Field Values

USER_INPUT_TRANSLATIONS_RESOURCE_NAME

static final String USER_INPUT_TRANSLATIONS_RESOURCE_NAME

The base name of the XML file that specifies the User Input langpack. Searched is for the file with the name expanded by _ISO3.

See Also:

Constant Field Values

PACK_TRANSLATIONS_RESOURCE_NAME

static final String PACK_TRANSLATIONS_RESOURCE_NAME

The base name of the XML file that specifies the pack langpack. Searched is for the file with the name expanded by _ISO3.

See Also:

Constant Field Values

CUSTOM_ICONS_RESOURCE_NAME

static final String CUSTOM_ICONS_RESOURCE_NAME

The base name of the XML file that specifies the custom icons.

See Also:

Constant Field Values

DEFAULT_INSTALL_LOGGING_CONFIGURATION_RES

static final String DEFAULT_INSTALL_LOGGING_CONFIGURATION_RES

The install Java logging configuration.

See Also:

Constant Field Values

Method Detail

getInputStream

InputStream getInputStream(String name)

Returns the stream to a resource.

Parameters:

name - the resource name

Returns:

a stream to the resource

Throws:

ResourceNotFoundException - if the resource cannot be found

getURL

URL getURL(String name)

Returns the URL to a resource.

Parameters:

name - the resource name

Returns:

the URL to the resource

Throws:

ResourceNotFoundException - if the resource cannot be found

getString

String getString(String name)

Returns a UTF-8 encoded resource as a string.

Parameters:

name - the resource name

Returns:

the resource as a string

Throws:

ResourceNotFoundException - if the resource cannot be found

ResourceException - if the resource cannot be retrieved

getString

String getString(String name,
                 String defaultValue)

Returns a UTF-8 encoded resource as a string.

Parameters:

name - the resource name

defaultValue - the default value, if the resource cannot be found or retrieved

Returns:

the resource as a string, or defaultValue if cannot be found or retrieved

getString

String getString(String name,
                 String encoding,
                 String defaultValue)

Returns a resource as a string.

Parameters:

name - the resource name

encoding - the resource encoding. May be null

defaultValue - the default value, if the resource cannot be found or retrieved

Returns:

the resource as a string, or defaultValue if cannot be found or retrieved

getObject

Object getObject(String name)
          throws ResourceException,
                 ResourceNotFoundException

Returns an object resource.

Parameters:

name - the resource name

Returns:

the object resource

Throws:

ResourceNotFoundException - if the resource cannot be found

ResourceException - if the resource cannot be retrieved

getImageIcon

ImageIcon getImageIcon(String name,
                       String... alternatives)

Returns an ImageIcon resource.

Parameters:

name - the resource name

alternatives - alternative resource names, if name is not found

Returns:

the corresponding ImageIcon

Throws:

ResourceNotFoundException - if the resource cannot be found