net.yacy.gui.framework

Class Switchboard

java.lang.Object

net.yacy.gui.framework.Switchboard

public class Switchboard
extends java.lang.Object

a static class that holds application-wide parameters very useful because global settings need not be passed to all classes and methods

Author:

m.christen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Switchboard.InfoUpdater
static class	Switchboard.shutdownHookThread This class is a helper class whose instance is started, when the java virtual machine shuts down.

Field Summary

Fields

Modifier and Type	Field and Description
static javax.swing.text.JTextComponent	InfoBox
private static java.lang.String	InfoBoxMessage
private static long	InfoBoxMessageUntil
static ConcurrentLog	log
private static java.util.Properties	properties a global properties object
private static boolean	shallrun the shallrun variable is used by all application parts to see if they must terminate

Constructor Summary

Constructors

Constructor and Description
Switchboard()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addShutdownHook(java.lang.Thread mainThread, java.util.concurrent.Semaphore semaphore)
static java.lang.String	get(java.lang.String key) access to the properties object
static java.lang.String	get(java.lang.String key, java.lang.String dflt) access to the properties object
static boolean	getBool(java.lang.String key, boolean dflt) convenience access to boolean values in properties
static java.io.File	getFile(java.lang.String key)
static int	getInt(java.lang.String key, int dflt) convenience access to integer values in properties
static void	info(java.lang.String infoString, long infoTime)
static void	load(java.io.File propFile) initialize the properties with the content of a file
static void	set(java.lang.String key, boolean value) convenience method to set a boolean property
static void	set(java.lang.String key, int value) convenience method to set a integer property
static void	set(java.lang.String key, java.lang.String value) set a property
static boolean	shallrun() test if the application shall run
static void	shutdown() set a termination signal.
static void	startInfoUpdater()

Methods inherited from class java.lang.Object

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

Field Detail

shallrun

private static boolean shallrun

the shallrun variable is used by all application parts to see if they must terminate

properties

private static java.util.Properties properties

a global properties object

log

public static final ConcurrentLog log

InfoBox

public static javax.swing.text.JTextComponent InfoBox

InfoBoxMessage

private static java.lang.String InfoBoxMessage

InfoBoxMessageUntil

private static long InfoBoxMessageUntil

Constructor Detail

Switchboard

public Switchboard()

Method Detail

startInfoUpdater

public static void startInfoUpdater()

addShutdownHook

public static void addShutdownHook(java.lang.Thread mainThread,
                   java.util.concurrent.Semaphore semaphore)

info

public static void info(java.lang.String infoString,
        long infoTime)

shallrun

public static boolean shallrun()

test if the application shall run

Returns:

true if the application shall run

shutdown

public static void shutdown()

set a termination signal. this is not reversible.

load

public static void load(java.io.File propFile)

initialize the properties with the content of a file

Parameters:

propFile -

get

public static java.lang.String get(java.lang.String key)

access to the properties object

Parameters:

key -

Returns:

the property value or null if the property does not exist

get

public static java.lang.String get(java.lang.String key,
                   java.lang.String dflt)

access to the properties object

Parameters:

key -

dflt -

Returns:

getInt

public static int getInt(java.lang.String key,
         int dflt)

convenience access to integer values in properties

Parameters:

key -

dflt -

Returns:

getBool

public static boolean getBool(java.lang.String key,
              boolean dflt)

convenience access to boolean values in properties

Parameters:

key -

dflt -

Returns:

getFile

public static java.io.File getFile(java.lang.String key)

set

public static void set(java.lang.String key,
       java.lang.String value)

set a property

Parameters:

key -

value -

set

public static void set(java.lang.String key,
       int value)

convenience method to set a integer property

Parameters:

key -

value -

set

public static void set(java.lang.String key,
       boolean value)

convenience method to set a boolean property

Parameters:

key -

value -