Cramfull Compiled Resources v2.00
A B C D E G H I J M O R S T W

A

add(String) - Method in class be.arci.cramfull.Collector
Not documented.
addResource(CompilerEntry) - Method in class be.arci.cramfull.ClassCompiler
Encodes a resource defined by a CompilerEntry object into the Cramfull subclass.
addResource(CompilerEntry) - Method in class be.arci.pub.ResourceCompiler
Adds a CompilerEntry to compile, checking for duplicates on canonical file name
addSerialized(String, String, Object) - Method in class be.arci.cramfull.ClassCompiler
Encodes a serializable object into the Cramfull subclass.
ASCIIDecoder - class be.arci.cramfull.ASCIIDecoder.
Decoder for resources encoded by the default ASCIIEncoder implementation of Encoder.
ASCIIDecoder() - Constructor for class be.arci.cramfull.ASCIIDecoder
 
ASCIIEncoder - class be.arci.cramfull.ASCIIEncoder.
Default Encoder implementation of the cramfull package.
ASCIIEncoder() - Constructor for class be.arci.cramfull.ASCIIEncoder
 

B

be.arci.cramfull - package be.arci.cramfull
The Cramfull Compiled Resources library enables to distribute resources for Java applications in compiled form, with internationalization support.
be.arci.pub - package be.arci.pub
Supplies some example implementations and utilities for the Cramfull Compiled Resources library, together with their source code.

C

CharDecoder - class be.arci.pub.CharDecoder.
Example Decoder implementation for resources encoded by the CharEncoder implementation of Encoder.
CharDecoder() - Constructor for class be.arci.pub.CharDecoder
 
CharEncoder - class be.arci.pub.CharEncoder.
Example Encoder implementation, that encodes each byte as it's char value.
CharEncoder() - Constructor for class be.arci.pub.CharEncoder
 
checkContents() - Method in class be.arci.pub.ResourceViewer
View list of resources or dump them all to local file system
ClassCompiler - class be.arci.cramfull.ClassCompiler.
Encodes resource files and serializable Objects, and compiles them into a Java .class file that is a subclass of Cramfull.
ClassCompiler(File, String, boolean, boolean, boolean) - Constructor for class be.arci.cramfull.ClassCompiler
Opens a Cramfull subclass's .class file for writing resources in to.
closeCompiler() - Method in class be.arci.pub.ResourceCompiler
Calls ClassCompiler to encode the resources and compile the class.
Collector - class be.arci.cramfull.Collector.
Helper class for Cramfull subclasses that collects all resources compiled into them; except for the get/setDebugMode methods, application programmers will not have to access this class directly.
compile() - Method in class be.arci.cramfull.ClassCompiler
Compiles the Java methods needed to decode the resources added to the Cramfull subclass, and closes that subclass's .class file.
compile(Vector) - Method in class be.arci.pub.ResourceCompiler
Does everything else.
compiler - Variable in class be.arci.pub.ResourceCompiler
 
CompilerEntry - class be.arci.cramfull.CompilerEntry.
Definition of a resource file to be encoded by a ClassCompiler.
CompilerEntry(File, String) - Constructor for class be.arci.cramfull.CompilerEntry
Creates a CompilerEntry for the resource at flPath, with as resource name flPath.getPath().
CompilerEntry(File, String, String) - Constructor for class be.arci.cramfull.CompilerEntry
Creates a CompilerEntry for the resource at flPath.
CompilerEntry(String, File, String) - Constructor for class be.arci.cramfull.CompilerEntry
Creates a CompilerEntry for the resource at flPath, with as resource name sBaseName + flPath.getPath().
Cramfull - class be.arci.cramfull.Cramfull.
The abstract class Cramfull is a framework for it's subclasses to encapsulate resources in their .class-file itself.
Cramfull(Hashtable) - Constructor for class be.arci.cramfull.Cramfull
Initializes a Cramfull subclass with a set of key-value pairs.

D

decode(int) - Method in class be.arci.cramfull.Decoder
Decodes a resource from a sequence of char-s.
decode(int) - Method in class be.arci.cramfull.ASCIIDecoder
 
decode(int) - Method in class be.arci.pub.TwoByteDecoder
 
decode(int) - Method in class be.arci.pub.CharDecoder
 
Decoder - class be.arci.cramfull.Decoder.
Decodes resources that are encoded into a Cramfull subclass.
Decoder() - Constructor for class be.arci.cramfull.Decoder
 
DEFAULT_CRAMFULL - Static variable in class be.arci.pub.ResourceCompiler
Default qualified class-name for Cramfull subclass to compile (this class) or view (ResourceViewer)

E

encode(DataInput, int) - Method in class be.arci.cramfull.Encoder
Encodes the resource file into a sequence of char-s; implementations must invoke write(char c) for each encoded char.
encode(DataInput, int) - Method in class be.arci.cramfull.ASCIIEncoder
 
encode(DataInput, int) - Method in class be.arci.pub.TwoByteEncoder
 
encode(DataInput, int) - Method in class be.arci.pub.CharEncoder
 
Encoder - class be.arci.cramfull.Encoder.
Encodes resources into an internal form that can be handled by the ClassCompiler.
Encoder() - Constructor for class be.arci.cramfull.Encoder
 
expandCommandfiles(String[]) - Static method in class be.arci.pub.ResourceCompiler
Expands command file arguments into args.

G

getAudioClip(String) - Method in class be.arci.cramfull.Cramfull
Returns an AudioClip object created from the named resource's data.
getAudioClip(String, int) - Method in class be.arci.cramfull.Cramfull
Returns an AudioClip object loaded from the named resource's data.
getByteArray(String) - Method in class be.arci.cramfull.Cramfull
Returns the named resource as a byte[] containing the resource's decoded data as read from the original resource file.
getByteArray(String, int) - Method in class be.arci.cramfull.Cramfull
Returns the named resource as a byte[] containing the resource's decoded data as read from the original resource file.
getCanonicalPath() - Method in class be.arci.cramfull.CompilerEntry
Returns the canonical form of the file path to the resource defined by this CompilerEntry.
getDebugMode() - Static method in class be.arci.cramfull.Collector
Gets debug mode
getDecoderClassName() - Method in class be.arci.cramfull.Encoder
Returns the qualified java class name (no .class suffix), which is associated with the resource's internal form.
getDecoderClassName() - Method in class be.arci.cramfull.ASCIIEncoder
The Decoder associated with this Encoder is be.arci.cramfull.ASCIIDecoder
getDecoderClassName() - Method in class be.arci.pub.TwoByteEncoder
The Decoder associated with this Encoder is be.arci.pub.TwoByteDecoder
getDecoderClassName() - Method in class be.arci.pub.CharEncoder
The Decoder associated with this Encoder is be.arci.pub.CharDecoder
getDeserialized(String) - Method in class be.arci.cramfull.Cramfull
Returns the named resource as an Object deserialized from the encoded resource.
getDeserialized(String, int) - Method in class be.arci.cramfull.Cramfull
Returns the named resource as an Object deserialized from the encoded resource.
getEncoder() - Method in class be.arci.cramfull.CompilerEntry
Returns the Encoder for the resource defined by this CompilerEntry.
getImage(String) - Method in class be.arci.cramfull.Cramfull
Returns an Image object created from the named resource's data.
getImage(String, int) - Method in class be.arci.cramfull.Cramfull
Returns a Image object created from the named resource's data.
getInputStream(String) - Method in class be.arci.cramfull.Cramfull
Returns the named resource as an InputStream from which the resource's decoded data can be read, just as if an InputStream had been opened on the original resource file.
getInputStream(String, int) - Method in class be.arci.cramfull.Cramfull
Returns the named resource as an InputStream from which the resource's decoded data can be read, just as if an InputStream had been opened on the original resource file.
getKeys() - Method in class be.arci.cramfull.Cramfull
Implementation of ResourceBundle.getKeys().
getLocaleSuffix() - Method in class be.arci.cramfull.Cramfull
Tries to get the locale of a Cramfull subclass by calling the Java2-added method ResourceBundle.getLocale().
getLocaleSuffix(String) - Method in class be.arci.cramfull.Cramfull
Returns the locale suffix of the first Cramfull subclass in the locale hierarchy obtained by java.util.ResourceBundle.getBundle() that contains the named resource.
getLocalizedProperties(String) - Method in class be.arci.cramfull.Cramfull
Returns a Properties object for the given basename, with a locale hierarchy that reflects that of this Cramfull object and it's parents, in as far as this Cramfull object was instantiated by ResourceBundle.getBundle().
getLocalizedProperties(String, int) - Method in class be.arci.cramfull.Cramfull
Returns a Properties object for the given basename, with a locale hierarchy that reflects that of this Cramfull object and it's parents, in as far as this Cramfull object was instantiated by ResourceBundle.getBundle().
getParameterInfo() - Method in class be.arci.pub.ResourceViewer
 
getProperties(String) - Method in class be.arci.cramfull.Cramfull
Returns a java.util.Properties object loaded from the named resource's data.
getProperties(String, int) - Method in class be.arci.cramfull.Cramfull
Returns a java.util.Properties object loaded from the named resource's data.
getResourceName() - Method in class be.arci.cramfull.CompilerEntry
Returns the resource name of the resource defined by this CompilerEntry.
getResources() - Method in class be.arci.cramfull.Collector
Not documented.
getResources(String) - Static method in class be.arci.cramfull.Collector
Not documented.
guessMIMEType(String) - Method in class be.arci.cramfull.Cramfull
Tries to determine the content type of a resource, based on it's decoded data.
guessMIMETypeFromName(String) - Static method in class be.arci.cramfull.Cramfull
Tries to determine the content type of a resource, based on it's name.

H

handleGetObject(String) - Method in class be.arci.cramfull.Cramfull
Retrieves the named resource from this Cramfull's set of compiled resources, in it's encoded or cached form.

I

init() - Method in class be.arci.pub.ResourceViewer
 
itemStateChanged(ItemEvent) - Method in class be.arci.pub.ResourceViewer
 

J

JOKER - Static variable in class be.arci.cramfull.ClassCompiler
Matches many char in a filename pattern (the character '*')

M

main(String[]) - Static method in class be.arci.pub.ResourceCompiler
Runs a ResourceCompiler with commandline arguments.
main(String[]) - Static method in class be.arci.pub.SerializingResourceCompiler
Example of invoking a modified version of SerializingResourceCompiler.
main(String[]) - Static method in class be.arci.pub.ResourceViewer
Runs ResourceViewer as an application
matchesWildcardPattern(String, String, boolean) - Static method in class be.arci.cramfull.ClassCompiler
Utility method that performs wildcard filename matches on behalf of user interfaces to ClassCompiler.
mouseClicked(MouseEvent) - Method in class be.arci.pub.ResourceViewer
 
mouseEntered(MouseEvent) - Method in class be.arci.pub.ResourceViewer
 
mouseExited(MouseEvent) - Method in class be.arci.pub.ResourceViewer
 
mousePressed(MouseEvent) - Method in class be.arci.pub.ResourceViewer
 
mouseReleased(MouseEvent) - Method in class be.arci.pub.ResourceViewer
 

O

open(String) - Method in class be.arci.cramfull.Collector
Not documented.
openCompiler(File, String, boolean) - Method in class be.arci.pub.ResourceCompiler
Opens a new ClassCompiler, which starts writing the output class.
openCompiler(File, String, boolean) - Method in class be.arci.pub.SerializingResourceCompiler
Opens a new ClassCompiler, which starts writing the output class, and then adds an array of objects to it through serialization.

R

read() - Method in class be.arci.cramfull.Decoder
Reads the next char from the internal form of the encoded resource.
remove(String, boolean) - Method in class be.arci.cramfull.Cramfull
Remove the reference to the named resource from this Cramfull subclass or the first parent in the locale hierarchy that contains the resource.
ResourceCompiler - class be.arci.pub.ResourceCompiler.
Utility class to compile a (set of) Resorcer subclass(es).
ResourceCompiler() - Constructor for class be.arci.pub.ResourceCompiler
Does nothing
ResourceDecodingException - exception be.arci.cramfull.ResourceDecodingException.
Special case of a MissingResourceException where the resource is not really missing from the Cramfull subclass and it's parent in a ResourceBundle, but cannot be retrieved due to an encoding or decoding error.
ResourceDecodingException(String, String, String) - Constructor for class be.arci.cramfull.ResourceDecodingException
Constructs a ResourceDecodingException with the specified information.
ResourceViewer - class be.arci.pub.ResourceViewer.
Utility class to view, list or dump the resources contained by compiler Cramfull subclasses.
ResourceViewer() - Constructor for class be.arci.pub.ResourceViewer
 
RET_CACHE - Static variable in class be.arci.cramfull.Cramfull
Resource retention: cache the decoded resource in the retrieved format, by replacing it's encoded form in the Cramfull subclass that stored it.
RET_CACHE_ALL - Static variable in class be.arci.cramfull.Cramfull
Resource retention: cache a decoded resource and it's parents in their respective containing Cramfull subclass as the java.util.Properties object each is loaded in.
RET_CACHE_AND_REMOVE_PARENTS - Static variable in class be.arci.cramfull.Cramfull
Resource retention: combination of RET_CACHE and RET_REMOVE_PARENTS
RET_ENCODED - Static variable in class be.arci.cramfull.Cramfull
Resource retention: keep encoded resource data (does nothing with the resource store, in fact).
RET_REMOVE - Static variable in class be.arci.cramfull.Cramfull
Resource retention: remove the reference to the resource from the Cramfull subclass that stores it.
RET_REMOVE_ALL - Static variable in class be.arci.cramfull.Cramfull
Resource retention: remove the reference to the resource from the Cramfull subclass that stores it and all it's eventual parent Cramfull-s.
RET_REMOVE_PARENTS - Static variable in class be.arci.cramfull.Cramfull
Resource retention: remove eventual references to the resource from all parent Cramfull-s of the Cramfull subclass that stores the resource.

S

sCopy - Static variable in class be.arci.cramfull.ClassCompiler
Copyright notice; none of the Cramfull Compiled Resources license types allows you to change this.
sCopy - Static variable in class be.arci.cramfull.ASCIIEncoder
Copyright notice; none of the Cramfull Compiled Resources license types allows you to change this.
sCopy - Static variable in class be.arci.cramfull.Collector
Copyright notice; none of the Cramfull Compiled Resources license types allows you to change this.
sCopy - Static variable in class be.arci.cramfull.Cramfull
Copyright notice; none of the Cramfull Compiled Resources license types allows you to change this.
sEncoder - Variable in class be.arci.pub.ResourceCompiler
Encoder to use for subsequent resources
SERIALIZED_TAG - Static variable in class be.arci.pub.SerializingResourceCompiler
Tag by which the ResourceViewer utility recognizes serialized arrays of Objects.
SerializingResourceCompiler - class be.arci.pub.SerializingResourceCompiler.
Skeleton example for extending ResourceCompiler to add serialized objects when compiling a Cramfull subclass.
SerializingResourceCompiler() - Constructor for class be.arci.pub.SerializingResourceCompiler
 
setAudioClipCandidates(String[]) - Static method in class be.arci.cramfull.Cramfull
Sets the possible java.applet.AudioClip implementations to search for.
setDebugMode(boolean) - Static method in class be.arci.cramfull.Collector
Sets verbose reporting of collecting resources from a Cramfull class file.
setVerbose(boolean) - Method in class be.arci.cramfull.ClassCompiler
Sets verbose mode on or off
showResource(String) - Method in class be.arci.pub.ResourceViewer
Displays current resource (current item in lstResources) in pnlResource, depending on it's MIME type or it's resource name.
sort(List) - Method in class be.arci.pub.ResourceViewer
Simple sort routine for small collections

T

toString() - Method in class be.arci.cramfull.CompilerEntry
Returns a String representation of this CompilerEntry containing the canonical form of the file path to the resource defined by this CompilerEntry, it's resource name, and the class name of the Encoder subclass.
TwoByteDecoder - class be.arci.pub.TwoByteDecoder.
Example Decoder implementation for resources encoded by the TwoByteEncoder implementation of Encoder.
TwoByteDecoder() - Constructor for class be.arci.pub.TwoByteDecoder
 
TwoByteEncoder - class be.arci.pub.TwoByteEncoder.
Example Encoder implementation, that encodes 2 bytes as 1 char.
TwoByteEncoder() - Constructor for class be.arci.pub.TwoByteEncoder
 

W

WILDCARD - Static variable in class be.arci.cramfull.ClassCompiler
Matches any char in a filename pattern (the character '?')
windowActivated(WindowEvent) - Method in class be.arci.pub.ResourceViewer
 
windowClosed(WindowEvent) - Method in class be.arci.pub.ResourceViewer
 
windowClosing(WindowEvent) - Method in class be.arci.pub.ResourceViewer
 
windowDeactivated(WindowEvent) - Method in class be.arci.pub.ResourceViewer
 
windowDeiconified(WindowEvent) - Method in class be.arci.pub.ResourceViewer
 
windowIconified(WindowEvent) - Method in class be.arci.pub.ResourceViewer
 
windowOpened(WindowEvent) - Method in class be.arci.pub.ResourceViewer
 
write(char) - Method in class be.arci.cramfull.Encoder
Appends an encoded char to the resource's internal form.

A B C D E G H I J M O R S T W
Cramfull Compiled Resources v2.00