Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
A B C E G H I L M N P R S T V

A

addModule(Module) - Method in class com.dghda.module.ModuleLoader
Attempt to add the given module.
addModulePath(String) - Method in class com.dghda.module.ModuleLoader
Add a module path component to the scan list.
author - Variable in class com.dghda.module.Module.ModuleVersion
The module's author.

B

BaseModule - class com.dghda.module.BaseModule.
A base implementation of a module.
BaseModule(String, String, String, Module.ModuleVersion) - Constructor for class com.dghda.module.BaseModule
Create a new module.

C

checkProvidersModules(ModulePathComponent.Provider) - Method in class com.dghda.module.ModuleLoader
(Re)loads the modules provided by the given provider, if appropriate.
checkProvidersModules(Class) - Method in class com.dghda.module.ModuleLoader
(Re)loads the modules provided by the given provider, if appropriate.
com.dghda.module - package com.dghda.module
 
compareTo(Object) - Method in class com.dghda.module.Module.ModuleVersion
Compares two versions.
constructModulePath(String[]) - Static method in class com.dghda.module.ModuleLoader
Constructs a path string in the same form as the classpath from an array of paths.
createPathComponent(String) - Method in class com.dghda.module.ModuleLoader
Converts a string into a ModulePathComponent object.

E

equals(Object) - Method in class com.dghda.module.Module.ModuleVersion
Checks two versions for equality.

G

getAvailableModules() - Method in class com.dghda.module.ModuleLoader
Returns a list of all modules available to the given user.
getComponent(String) - Method in class com.dghda.module.ModulePathDirComponent
Return the component representing the given file.
getDescription() - Method in class com.dghda.module.BaseModule
Returns a description of the module.
getDescription() - Method in interface com.dghda.module.Module
Returns a description of the module.
getID() - Method in class com.dghda.module.BaseModule
Returns the module's ID.
getID() - Method in interface com.dghda.module.Module
Returns the ID of the module.
getInputStream() - Method in class com.dghda.module.ModulePathComponent.Provider
 
getInputStream() - Method in class com.dghda.module.ModulePathJarComponent.JarEntryProvider
Returns an input stream for reading the entry.
getModified() - Method in class com.dghda.module.ModulePathComponent.Provider
 
getModified() - Method in class com.dghda.module.ModulePathJarComponent.JarEntryProvider
Returns the entry's last modification time.
getModule(String) - Method in class com.dghda.module.ModuleLoader
Returns the given module.
getModule(String) - Method in interface com.dghda.module.ModuleProvider
Returns the module instance with the given ID.
getModuleIterator() - Method in interface com.dghda.module.ModuleProvider
An iterator over all modules provided.
getName() - Method in class com.dghda.module.BaseModule
Returns the name of the module.
getName() - Method in interface com.dghda.module.Module
Returns the name of the module.
getName() - Method in class com.dghda.module.ModulePathComponent.Provider
 
getName() - Method in class com.dghda.module.ModulePathJarComponent.JarEntryProvider
Returns the entry's name.
getNextEntry() - Method in class com.dghda.module.ModulePathDirComponent.DirIterator
 
getNextEntry() - Method in class com.dghda.module.ModulePathJarComponent.JarIterator
 
getPath() - Method in class com.dghda.module.InvalidPathException
 
getPath() - Method in interface com.dghda.module.ModulePathComponent
Returns the path the component was constructed from.
getPath() - Method in class com.dghda.module.ModulePathDirComponent
Returns the path to the directory.
getPath() - Method in class com.dghda.module.ModulePathFileComponent
Returns the path to the file.
getPath() - Method in class com.dghda.module.ModulePathJarComponent
Returns the path to the jar file.
getProvider() - Method in class com.dghda.module.ModulePathFileComponent
Return a provider representing the file.
getProviders(boolean) - Method in interface com.dghda.module.ModulePathComponent
Iterate over all providers.
getProviders(boolean) - Method in class com.dghda.module.ModulePathDirComponent
Iterate over all providers in the directory.
getProviders(boolean) - Method in class com.dghda.module.ModulePathFileComponent
The iterator will return at most one provider.
getProviders(boolean) - Method in class com.dghda.module.ModulePathJarComponent
Iterate over all providers in the jar file.
getVersion() - Method in class com.dghda.module.BaseModule
Returns version information about the module.
getVersion() - Method in interface com.dghda.module.Module
Returns version information about the module.

H

hasNext() - Method in class com.dghda.module.ModulePathComponent.EmptyIterator
Returns false.
hasNext() - Method in class com.dghda.module.ModulePathDirComponent.DirIterator
Returns true if there is another provider available.
hasNext() - Method in class com.dghda.module.ModulePathFileComponent.FileIterator
Returns true for the first element only.
hasNext() - Method in class com.dghda.module.ModulePathJarComponent.JarIterator
Returns true if there is another provider available.

I

InvalidPathException - exception com.dghda.module.InvalidPathException.
The module path given was invalid.
InvalidPathException(String) - Constructor for class com.dghda.module.InvalidPathException
 
InvalidPathException(String, String) - Constructor for class com.dghda.module.InvalidPathException
 

L

loadClass(String, InputStream) - Method in class com.dghda.module.StreamClassLoader
Attempts to load a class from the given stream, and instatiate an instance of it.
loadClassData(InputStream) - Static method in class com.dghda.module.StreamClassLoader
Loads class data from the class file.

M

Module - interface com.dghda.module.Module.
A loadable module.
Module.ModuleVersion - class com.dghda.module.Module.ModuleVersion.
A class which encapsulates a module's version information.
Module.ModuleVersion(int, int, String) - Constructor for class com.dghda.module.Module.ModuleVersion
Constructs a new version object.
ModuleLoader - class com.dghda.module.ModuleLoader.
A module loader object manages a set of loadable objects.
ModuleLoader(Class, String, Logger) - Constructor for class com.dghda.module.ModuleLoader
Create a new module loader for the given class, using the given path(s), and no constructor arguments.
ModuleLoader(Class, String[], Logger) - Constructor for class com.dghda.module.ModuleLoader
Create a new module loader for the given class, using the given path(s), and the given constructor arguments.
ModuleLoader(Class, String, Object[], Logger) - Constructor for class com.dghda.module.ModuleLoader
Create a new module loader for the given class, using the given path(s) and constructor arguments.
ModuleLoader(Class, String[], Object[], Logger) - Constructor for class com.dghda.module.ModuleLoader
Create a new module loader for the given class, using the given path(s) and constructor arguments.
ModulePathComponent - interface com.dghda.module.ModulePathComponent.
A module path component interface provides access to zero or more module providers.
ModulePathComponent.EmptyIterator - class com.dghda.module.ModulePathComponent.EmptyIterator.
An empty iterator.
ModulePathComponent.EmptyIterator() - Constructor for class com.dghda.module.ModulePathComponent.EmptyIterator
 
ModulePathComponent.Provider - class com.dghda.module.ModulePathComponent.Provider.
Details of a provider.
ModulePathComponent.Provider() - Constructor for class com.dghda.module.ModulePathComponent.Provider
 
ModulePathDirComponent - class com.dghda.module.ModulePathDirComponent.
A module path directory component provides access to module providers in a directory.
ModulePathDirComponent(String) - Constructor for class com.dghda.module.ModulePathDirComponent
Create a new path component representing the specified directory.
ModulePathDirComponent.DirIterator - class com.dghda.module.ModulePathDirComponent.DirIterator.
An iterator over the contents of the directory.
ModulePathDirComponent.DirIterator(boolean, long) - Constructor for class com.dghda.module.ModulePathDirComponent.DirIterator
Create a new iterator.
ModulePathFileComponent - class com.dghda.module.ModulePathFileComponent.
A module path file component provides access to a module provider from a file.
ModulePathFileComponent(String) - Constructor for class com.dghda.module.ModulePathFileComponent
Create a new ModulePathFileComponent representing the given file.
ModulePathFileComponent.FileIterator - class com.dghda.module.ModulePathFileComponent.FileIterator.
An iterator that returns a provider for a file.
ModulePathFileComponent.FileIterator() - Constructor for class com.dghda.module.ModulePathFileComponent.FileIterator
 
ModulePathJarComponent - class com.dghda.module.ModulePathJarComponent.
A module path jar component provides access to module providers in a jar file.
ModulePathJarComponent(String) - Constructor for class com.dghda.module.ModulePathJarComponent
Create a new path component representing the specified jar file.
ModulePathJarComponent.JarEntryProvider - class com.dghda.module.ModulePathJarComponent.JarEntryProvider.
An implementation of a provider based on a jar file entry.
ModulePathJarComponent.JarEntryProvider(JarEntry) - Constructor for class com.dghda.module.ModulePathJarComponent.JarEntryProvider
Create a new provider using the given entry.
ModulePathJarComponent.JarIterator - class com.dghda.module.ModulePathJarComponent.JarIterator.
An iterator over the contents of the jar file.
ModulePathJarComponent.JarIterator(boolean, long) - Constructor for class com.dghda.module.ModulePathJarComponent.JarIterator
Create a new iterator.
ModuleProvider - interface com.dghda.module.ModuleProvider.
The interface that classes contained in the module loader path must implement.
m_ConstructorArgs - Variable in class com.dghda.module.ModuleLoader
 
m_Current - Variable in class com.dghda.module.ModulePathDirComponent.DirIterator
 
m_Current - Variable in class com.dghda.module.ModulePathJarComponent.JarIterator
 
m_Description - Variable in class com.dghda.module.BaseModule
 
m_Entries - Variable in class com.dghda.module.ModulePathDirComponent.DirIterator
 
m_Entry - Variable in class com.dghda.module.ModulePathJarComponent.JarEntryProvider
 
m_Enum - Variable in class com.dghda.module.ModulePathJarComponent.JarIterator
 
m_File - Variable in class com.dghda.module.ModulePathDirComponent
 
m_File - Variable in class com.dghda.module.ModulePathFileComponent
 
m_File - Variable in class com.dghda.module.ModulePathJarComponent
 
m_FileComponents - Variable in class com.dghda.module.ModulePathDirComponent
 
m_First - Variable in class com.dghda.module.ModulePathFileComponent.FileIterator
 
m_ID - Variable in class com.dghda.module.BaseModule
 
m_Index - Variable in class com.dghda.module.ModulePathDirComponent.DirIterator
 
m_JarFile - Variable in class com.dghda.module.ModulePathJarComponent
 
m_LastScanned - Variable in class com.dghda.module.ModulePathDirComponent.DirIterator
 
m_LastScanned - Variable in class com.dghda.module.ModulePathJarComponent.JarIterator
 
m_Logger - Variable in class com.dghda.module.ModuleLoader
 
m_ModuleClass - Variable in class com.dghda.module.ModuleLoader
 
m_ModulePaths - Variable in class com.dghda.module.ModuleLoader
 
m_Modules - Variable in class com.dghda.module.ModuleLoader
 
m_Path - Variable in class com.dghda.module.InvalidPathException
 
m_Scanned - Variable in class com.dghda.module.ModulePathDirComponent
 
m_Scanned - Variable in class com.dghda.module.ModulePathFileComponent
 
m_Scanned - Variable in class com.dghda.module.ModulePathJarComponent
 
m_ShortName - Variable in class com.dghda.module.BaseModule
 
m_Updated - Variable in class com.dghda.module.ModulePathDirComponent.DirIterator
 
m_Updated - Variable in class com.dghda.module.ModulePathJarComponent.JarIterator
 
m_Version - Variable in class com.dghda.module.BaseModule
 
major - Variable in class com.dghda.module.Module.ModuleVersion
The major version number.
minor - Variable in class com.dghda.module.Module.ModuleVersion
The minor version number.

N

next() - Method in class com.dghda.module.ModulePathComponent.EmptyIterator
Throws a NoSuchElementException exception.
next() - Method in class com.dghda.module.ModulePathDirComponent.DirIterator
Returns the next provider.
next() - Method in class com.dghda.module.ModulePathFileComponent.FileIterator
Returns the file's provider.
next() - Method in class com.dghda.module.ModulePathJarComponent.JarIterator
Returns the next provider.

P

parseModulePath(String) - Static method in class com.dghda.module.ModuleLoader
Parses a path string in the same form as the classpath into an array of paths.

R

remove() - Method in class com.dghda.module.ModulePathComponent.EmptyIterator
Throws a UnsupportedOperationException exception.
remove() - Method in class com.dghda.module.ModulePathDirComponent.DirIterator
Throws a UnsupportedOperationException exception.
remove() - Method in class com.dghda.module.ModulePathFileComponent.FileIterator
Throws a UnsupportedOperationException exception.
remove() - Method in class com.dghda.module.ModulePathJarComponent.JarIterator
Throws a UnsupportedOperationException exception.
removeModulePath(String) - Method in class com.dghda.module.ModuleLoader
Remove a module path component from the scan list.

S

StreamClassLoader - class com.dghda.module.StreamClassLoader.
A class loader which will attempt to load a classes from a stream.
StreamClassLoader() - Constructor for class com.dghda.module.StreamClassLoader
Creates a new stream class loader using the system class loader as its parent.
StreamClassLoader(ClassLoader) - Constructor for class com.dghda.module.StreamClassLoader
Creates a new file class loader using the given class loader as its parent.
scan(boolean) - Method in class com.dghda.module.ModuleLoader
Scans the module path(s) for any new or updated modules.
setProperties(String, Properties) - Method in class com.dghda.module.Module.ModuleVersion
Sets the version properties in the given properties object.

T

toString() - Method in class com.dghda.module.Module.ModuleVersion
 

V

VERSION_AUTHOR - Static variable in class com.dghda.module.Module.ModuleVersion
The name of the property containing the module's author.
VERSION_MAJOR - Static variable in class com.dghda.module.Module.ModuleVersion
The name of the property containing the module's major version number.
VERSION_MINOR - Static variable in class com.dghda.module.Module.ModuleVersion
The name of the property containing the module's minor version number.

A B C E G H I L M N P R S T V