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

Quick Search    Search Deep
A C F G I K L M P R S T Z

A

add() - Method in class com.eireneh.config.ChoiceSet
Add all the key, model pairs in this hashtable
add(String, Choice) - Method in class com.eireneh.config.Config
Add a key/model pairing
addConfigListener(ConfigListener) - Method in class com.eireneh.config.Config
Add an Exception listener to the list of things wanting to know whenever we capture an Exception
applicationToLocal() - Method in class com.eireneh.config.Config
Take the data in the application and copy it to the local storage area.

C

Choice - interface com.eireneh.config.Choice.
Choice is the fundamental building block of the config system.
ChoiceSet - class com.eireneh.config.ChoiceSet.
A ConfigExtender represents a set of Choices that fit together in a sensible group.
ChoiceSet() - Constructor for class com.eireneh.config.ChoiceSet
 
Config - class com.eireneh.config.Config.
Config is the core part of the configuration system; it is simply a Collection of Choices.
Config(String) - Constructor for class com.eireneh.config.Config
Ensure that we can not be instansiated
ConfigEvent - class com.eireneh.config.ConfigEvent.
An event indicating that an exception has happened
Distribution Licence:
Project B is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
ConfigEvent(Object, String, Choice) - Constructor for class com.eireneh.config.ConfigEvent
Constructs an ConfigEvent object.
ConfigListener - interface com.eireneh.config.ConfigListener.
ConfigListener.
choiceAdded(ConfigEvent) - Method in interface com.eireneh.config.ConfigListener
Called whenever Config.add() is called
choiceRemoved(ConfigEvent) - Method in interface com.eireneh.config.ConfigListener
Called whenever Config.remove() is called
com.eireneh.config - package com.eireneh.config
 
config - Variable in class com.eireneh.config.ChoiceSet
The config that we are talking to

F

fireChoiceAdded(String, Choice) - Method in class com.eireneh.config.Config
A Choice got added
fireChoiceRemoved(String, Choice) - Method in class com.eireneh.config.Config
A Choice got added

G

getChoice(String) - Method in class com.eireneh.config.Config
Step through the keys
getChoice() - Method in class com.eireneh.config.ConfigEvent
Returns the choice.
getChoices() - Method in class com.eireneh.config.ChoiceSet
Accessor for the set of Choices
getHelpText() - Method in interface com.eireneh.config.Choice
Gets a brief description of what is going on
getKey() - Method in class com.eireneh.config.ConfigEvent
Returns the key.
getLeaf(String) - Static method in class com.eireneh.config.Config
What is the Path of this key
getLocal(String) - Method in class com.eireneh.config.Config
Get a configuration Choice (by name).
getNames() - Method in class com.eireneh.config.Config
The set of Choice Names that we are controlling
getPath(String) - Static method in class com.eireneh.config.Config
What is the Path of this key
getPath() - Method in class com.eireneh.config.ConfigEvent
Returns the choice.
getPaths() - Method in class com.eireneh.config.Config
The set of Choice Names that we are controlling
getProperties() - Method in class com.eireneh.config.Config
Take the data in the local storage area and store it permanently, using the specified stream.
getString() - Method in interface com.eireneh.config.Choice
String value to associate with the name (key)
getTitle() - Method in class com.eireneh.config.Config
 
getType() - Method in interface com.eireneh.config.Choice
This method is used to configure a good way of editing this component.
getTypeOptions() - Method in interface com.eireneh.config.Choice
This method is used to configure a the type selected above.
getUserLevel() - Method in interface com.eireneh.config.Choice
Gets a default user level (beginner to advanced)

I

isSaveable() - Method in interface com.eireneh.config.Choice
Is this Choice OK to write out to a file, or should we use settings in this run of the program, but forget them for next time.

K

key - Variable in class com.eireneh.config.ConfigEvent
The name of the choice
keys - Variable in class com.eireneh.config.Config
The array that stores the keys

L

listener_list - Variable in class com.eireneh.config.Config
The list of listeners
local - Variable in class com.eireneh.config.Config
The set of local values
localToApplication(boolean) - Method in class com.eireneh.config.Config
Take the data in the local storage area and copy it to the application.
localToPermanent(URL) - Method in class com.eireneh.config.Config
Take the data in the local storage area and store it permanently, using the configured storage area.
localToPermanent(String, int) - Method in class com.eireneh.config.Config
Take the data in the local storage area and store it permanently, using the configured storage area.
log - Static variable in class com.eireneh.config.Config
The log stream

M

model - Variable in class com.eireneh.config.ConfigEvent
The Choice
models - Variable in class com.eireneh.config.Config
The array that stores the models

P

PRIORITY_ACCESSOR - Static variable in interface com.eireneh.config.Choice
The priority level for configuring previously created items
PRIORITY_CTOR - Static variable in interface com.eireneh.config.Choice
The priority level for creating items for later configuring
PRIORITY_EXTENDER - Static variable in interface com.eireneh.config.Choice
The priority level for important but non system level stuff
PRIORITY_HIGHEST - Static variable in interface com.eireneh.config.Choice
The priority level for important but non system level stuff
PRIORITY_LOWEST - Static variable in interface com.eireneh.config.Choice
The lowest level priority generally for system level stuff
PRIORITY_NORMAL - Static variable in interface com.eireneh.config.Choice
The priority level for normal use
PRIORITY_SYSTEM - Static variable in interface com.eireneh.config.Choice
The highest level priority generally for system level stuff
permanentToLocal(URL) - Method in class com.eireneh.config.Config
Take the data stored permanently and copy it to the local storage area, using the configured storage area
permanentToLocal(String, int) - Method in class com.eireneh.config.Config
Take the data stored permanently and copy it to the local storage area, using the configured storage area
priority() - Method in interface com.eireneh.config.Choice
Sometimes we need to ensure that we configure items in a certain order, the config package moves the changes to the application starting with the highest priority, moving to the lowest.

R

remove() - Method in class com.eireneh.config.ChoiceSet
Add all the key, model pairs in this hashtable
remove(String) - Method in class com.eireneh.config.Config
Remove a key/model pairing
removeConfigListener(ConfigListener) - Method in class com.eireneh.config.Config
Remove an Exception listener from the list of things wanting to know whenever we capture an Exception
requiresRestart() - Method in interface com.eireneh.config.Choice
Do we need to restart the program in order for this change to have effect?

S

StartupException - exception com.eireneh.config.StartupException.
Something in the startup config files failed to start properly.
StartupException(String) - Constructor for class com.eireneh.config.StartupException
Construct the Exception with a message
StartupException(String, Throwable) - Constructor for class com.eireneh.config.StartupException
Construct the Exception with a message and a nested Exception
StartupException(String, Object[]) - Constructor for class com.eireneh.config.StartupException
Construct the Exception with a message and some I18N params
StartupException(String, Throwable, Object[]) - Constructor for class com.eireneh.config.StartupException
Construct the Exception with a message, a nested Exception and some I18N params
setConfig(Config) - Method in class com.eireneh.config.ChoiceSet
 
setLocal(String, String) - Method in class com.eireneh.config.Config
Set a configuration Choice (by name) to a new value.
setProperties(Properties) - Method in class com.eireneh.config.Config
Take the data stored permanetly and copy it to the local storage area, using the specified stream
setString(String) - Method in interface com.eireneh.config.Choice
String value to associate with this Field.
size() - Method in class com.eireneh.config.Config
The number of Choices

T

test(PrintWriter, boolean) - Method in class com.eireneh.config.ZTestConfigTest
A basic are we OK type test, for the Passage package.
testOptions() - Static method in class com.eireneh.config.ZTestConfigTest
Test the Strongs class.
title - Variable in class com.eireneh.config.Config
The name for dialog boxes and properties files

Z

ZTestConfigTest - class com.eireneh.config.ZTestConfigTest.
Attepmted 100% code coverage testing.
ZTestConfigTest() - Constructor for class com.eireneh.config.ZTestConfigTest
 

A C F G I K L M P R S T Z