jhelp.util.resources

Class Resources

java.lang.Object

jhelp.util.resources.Resources

public class Resources
extends java.lang.Object

Access to internal resources.
We strongly recommend to use the Resources(Class) constructor, for resources embed in different jar than the JHelp utilities.
For resources inside same jar as JHelp utilities, both constructor works

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	externalFiles Indicates if resources are outside the jar
private java.lang.Class<?>	referenceClass Reference class
private java.lang.String	relativePathFormClass Path relative to Resources class
private java.util.Hashtable<java.lang.String,ResourceText>	resourcesTexts Map of already loaded resources text

Constructor Summary

Constructors

Constructor and Description
Resources() Create a new instance of Resources.
Resources(java.lang.Class<?> referenceClass) Create a new instance of Resources with a reference class.
Resources(java.lang.String pathOfEmbedResources) Create a new instance of Resources with a relative base path.

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.image.BufferedImage	obtainBufferedImage(java.lang.String path) Obtain a buffered image
javax.swing.ImageIcon	obtainImageIcon(java.lang.String path) Obtain a image icon
JHelpImage	obtainJHelpImage(java.lang.String path) Obtain a JHelpImage
java.io.InputStream	obtainResourceStream(java.lang.String path) Open stream to a resource
ResourceText	obtainResourceText(java.lang.String path) Obtain a resource of texts
java.net.URL	obtainResourceURL(java.lang.String path) URL of a resource

Methods inherited from class java.lang.Object

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

Field Detail

externalFiles

private final boolean externalFiles

Indicates if resources are outside the jar

referenceClass

private final java.lang.Class<?> referenceClass

Reference class

relativePathFormClass

private final java.lang.String relativePathFormClass

Path relative to Resources class

resourcesTexts

private final java.util.Hashtable<java.lang.String,ResourceText> resourcesTexts

Map of already loaded resources text

Constructor Detail

Resources

public Resources()

Create a new instance of Resources.
The given path are relative next to the jar that contains this class

Resources

public Resources(java.lang.Class<?> referenceClass)

Create a new instance of Resources with a reference class.
The class reference must be in same jar as resources, all the given path will be relative to this given class

Parameters:

referenceClass - Reference class

Resources

public Resources(java.lang.String pathOfEmbedResources)

Create a new instance of Resources with a relative base path.
Resources to reach must be in same jar as this class, the path given is relative to this Resources class. Then givn path will be relative to the given path.

Parameters:

pathOfEmbedResources - Relative path where found resources

Method Detail

obtainBufferedImage

public java.awt.image.BufferedImage obtainBufferedImage(java.lang.String path)
                                                 throws java.io.IOException

Obtain a buffered image

Parameters:

path - Relative path of the image (Separator is "/")

Returns:

The buffered image

Throws:

java.io.IOException - On reading resource failure

obtainImageIcon

public javax.swing.ImageIcon obtainImageIcon(java.lang.String path)

Obtain a image icon

Parameters:

path - Relative path of the image (Separator is "/")

Returns:

The buffered image

obtainJHelpImage

public JHelpImage obtainJHelpImage(java.lang.String path)
                            throws java.io.IOException

Obtain a JHelpImage

Parameters:

path - Relative path of the image (Separator is "/")

Returns:

The buffered image

Throws:

java.io.IOException - On reading resource failure

obtainResourceStream

public java.io.InputStream obtainResourceStream(java.lang.String path)

Open stream to a resource

Parameters:

path - Relative path of the resource (Separator is "/")

Returns:

Opened stream or null if the resource not found

obtainResourceText

public ResourceText obtainResourceText(java.lang.String path)

Obtain a resource of texts

Parameters:

path - Relative path of the resource of texts (Separator is "/")

Returns:

Resources of text or null if the resource not found

obtainResourceURL

public java.net.URL obtainResourceURL(java.lang.String path)

URL of a resource

Parameters:

path - Relative path of the resource (Separator is "/")

Returns:

URL or null if the resource not found