ljbo82.util

Class EmbeddedResource

java.lang.Object

ljbo82.util.EmbeddedResource

public class EmbeddedResource
extends Object

Represents an embedded resource.

Author:

Leandro Oliveira (ljbo.82@gmail.com)

Constructor Summary

Constructors

Constructor and Description
EmbeddedResource(String embeddedPath)

Method Summary

Modifier and Type	Method and Description
UniversalFile	extract(UniversalFile destinationDir)
UniversalFile	extract(UniversalFile destinationDir, boolean forceOverwrite) Convenience method.
UniversalFile	extract(UniversalFile destinationDir, String destFilename, boolean forceOverwrite) Convenience method.
UniversalFile	extract(UniversalFile destDir, String destinationFilename, int bufferSize, boolean forceOverwrite) Extracts this embedded resource into a local file.
InputStream	getInputStream() Returns the input stream to access this embedded resource (inside application JAR).
String	getMd5Checksum() Convenience method.
String	getMd5Checksum(int bufferSize) Returns the MD5 of this embedded resource.
String	getPath()
URL	getUrl()

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedResource

public EmbeddedResource(String embeddedPath)
                 throws UniversalFile.FileAccessException

Throws:

UniversalFile.FileAccessException

Method Detail

getPath

public String getPath()

getUrl

public URL getUrl()

getInputStream

public InputStream getInputStream()

Returns the input stream to access this embedded resource (inside application JAR).

Returns:

the input stream to access this embedded resource (inside application JAR).

getMd5Checksum

public String getMd5Checksum(int bufferSize)
                      throws UniversalFile.FileAccessException

Returns the MD5 of this embedded resource.

Parameters:

bufferSize - buffer size

Returns:

the MD5 of an embedded resource.

Throws:

UniversalFile.FileAccessException - if an error happened during the calculation.

getMd5Checksum

public final String getMd5Checksum()
                            throws UniversalFile.FileAccessException

Convenience method.

Throws:

UniversalFile.FileAccessException

extract

public UniversalFile extract(UniversalFile destDir,
                             String destinationFilename,
                             int bufferSize,
                             boolean forceOverwrite)
                      throws UniversalFile.FileAccessException

Extracts this embedded resource into a local file.

Parameters:

destDir - directory where embedded resource should be extracted.

destinationFilename - filename of extracted resource.

bufferSize - read buffer size.

forceOverwrite - defines if an existing resource should be overwritten.

Returns:

file pointing to extracted resource.

Throws:

UniversalFile.FileAccessException - if an error happened during the process.

extract

public final UniversalFile extract(UniversalFile destinationDir,
                                   String destFilename,
                                   boolean forceOverwrite)
                            throws UniversalFile.FileAccessException

Convenience method.

Throws:

UniversalFile.FileAccessException

extract

public final UniversalFile extract(UniversalFile destinationDir,
                                   boolean forceOverwrite)
                            throws UniversalFile.FileAccessException

Convenience method.

Throws:

UniversalFile.FileAccessException

extract

public final UniversalFile extract(UniversalFile destinationDir)
                            throws UniversalFile.FileAccessException

Throws:

UniversalFile.FileAccessException