freenet.config

Class SubConfig

java.lang.Object

freenet.config.SubConfig

All Implemented Interfaces:

java.lang.Comparable<SubConfig>

public class SubConfig
extends java.lang.Object
implements java.lang.Comparable<SubConfig>

A specific configuration block.

Field Summary

Fields

Modifier and Type	Field and Description
Config	config

Constructor Summary

Constructors

Constructor and Description
SubConfig(java.lang.String prefix, Config config) Deprecated. Use Config.createSubConfig(String) instead

Method Summary

Modifier and Type	Method and Description
int	compareTo(SubConfig second)
SimpleFieldSet	exportFieldSet()
SimpleFieldSet	exportFieldSet(boolean withDefaults)
SimpleFieldSet	exportFieldSet(Config.RequestType configRequestType, boolean withDefaults)
void	finishedInitialization() Called when the object we are attached to has finished init.
void	fixOldDefault(java.lang.String name, java.lang.String value) If the option's value is equal to the provided old default, then set it to the new default.
void	fixOldDefaultRegex(java.lang.String name, java.lang.String value) If the option's value matches the provided old default regex, then set it to the new default.
void	forceUpdate(java.lang.String optionName) Force an option to be updated even if it hasn't changed.
boolean	getBoolean(java.lang.String optionName)
int	getInt(java.lang.String optionName)
long	getLong(java.lang.String optionName)
Option<?>	getOption(java.lang.String option)
Option<?>[]	getOptions() Return all the options registered.
java.lang.String	getPrefix()
java.lang.String	getRawOption(java.lang.String name)
short	getShort(java.lang.String optionName)
java.lang.String	getString(java.lang.String optionName)
java.lang.String[]	getStringArr(java.lang.String optionName)
boolean	hasFinishedInitialization() Has the object we are attached to finished initialization?
void	register(Option<?> o)
void	register(java.lang.String optionName, boolean defaultValue, int sortOrder, boolean expert, boolean forceWrite, java.lang.String shortDesc, java.lang.String longDesc, BooleanCallback cb)
void	register(java.lang.String optionName, int defaultValue, int sortOrder, boolean expert, boolean forceWrite, java.lang.String shortDesc, java.lang.String longDesc, IntCallback cb) Registers a bandwidth option.
void	register(java.lang.String optionName, int defaultValue, int sortOrder, boolean expert, boolean forceWrite, java.lang.String shortDesc, java.lang.String longDesc, IntCallback cb, boolean isSize)
void	register(java.lang.String optionName, long defaultValue, int sortOrder, boolean expert, boolean forceWrite, java.lang.String shortDesc, java.lang.String longDesc, LongCallback cb, boolean isSize)
void	register(java.lang.String optionName, short defaultValue, int sortOrder, boolean expert, boolean forceWrite, java.lang.String shortDesc, java.lang.String longDesc, ShortCallback cb, boolean isSize)
void	register(java.lang.String optionName, java.lang.String[] defaultValue, int sortOrder, boolean expert, boolean forceWrite, java.lang.String shortDesc, java.lang.String longDesc, StringArrCallback cb)
void	register(java.lang.String optionName, java.lang.String defaultValueString, int sortOrder, boolean expert, boolean forceWrite, java.lang.String shortDesc, java.lang.String longDesc, IntCallback cb) Registers a bandwidth option.
void	register(java.lang.String optionName, java.lang.String defaultValueString, int sortOrder, boolean expert, boolean forceWrite, java.lang.String shortDesc, java.lang.String longDesc, IntCallback cb, boolean isSize) Deprecated. Replaced by register(String, String, int, boolean, boolean, String, String, IntCallback, Dimension)
void	register(java.lang.String optionName, java.lang.String defaultValueString, int sortOrder, boolean expert, boolean forceWrite, java.lang.String shortDesc, java.lang.String longDesc, IntCallback cb, Dimension dimension)
void	register(java.lang.String optionName, java.lang.String defaultValueString, int sortOrder, boolean expert, boolean forceWrite, java.lang.String shortDesc, java.lang.String longDesc, LongCallback cb, boolean isSize)
void	register(java.lang.String optionName, java.lang.String defaultValue, int sortOrder, boolean expert, boolean forceWrite, java.lang.String shortDesc, java.lang.String longDesc, StringCallback cb)
Option<?>	removeOption(java.lang.String optionName)
void	set(java.lang.String name, boolean value)
void	set(java.lang.String name, java.lang.String value)
void	setOptions(SimpleFieldSet sfs) Set options from a SimpleFieldSet.

Methods inherited from class java.lang.Object

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

Field Detail

config

public final Config config

Constructor Detail

SubConfig

@Deprecated
public SubConfig(java.lang.String prefix,
                             Config config)

Deprecated. Use Config.createSubConfig(String) instead

Method Detail

getOptions

public Option<?>[] getOptions()

Return all the options registered. Each includes its name. Used by e.g. webconfig.

getOption

public Option<?> getOption(java.lang.String option)

register

public void register(Option<?> o)

register

public void register(java.lang.String optionName,
                     int defaultValue,
                     int sortOrder,
                     boolean expert,
                     boolean forceWrite,
                     java.lang.String shortDesc,
                     java.lang.String longDesc,
                     IntCallback cb,
                     boolean isSize)

register

public void register(java.lang.String optionName,
                     long defaultValue,
                     int sortOrder,
                     boolean expert,
                     boolean forceWrite,
                     java.lang.String shortDesc,
                     java.lang.String longDesc,
                     LongCallback cb,
                     boolean isSize)

register

public void register(java.lang.String optionName,
                     int defaultValue,
                     int sortOrder,
                     boolean expert,
                     boolean forceWrite,
                     java.lang.String shortDesc,
                     java.lang.String longDesc,
                     IntCallback cb)

Registers a bandwidth option.

See Also:

BandwidthOption

register

public void register(java.lang.String optionName,
                     java.lang.String defaultValueString,
                     int sortOrder,
                     boolean expert,
                     boolean forceWrite,
                     java.lang.String shortDesc,
                     java.lang.String longDesc,
                     IntCallback cb,
                     Dimension dimension)

register

@Deprecated
public void register(java.lang.String optionName,
                                 java.lang.String defaultValueString,
                                 int sortOrder,
                                 boolean expert,
                                 boolean forceWrite,
                                 java.lang.String shortDesc,
                                 java.lang.String longDesc,
                                 IntCallback cb,
                                 boolean isSize)

Deprecated. Replaced by register(String, String, int, boolean, boolean, String, String, IntCallback, Dimension)

register

public void register(java.lang.String optionName,
                     java.lang.String defaultValueString,
                     int sortOrder,
                     boolean expert,
                     boolean forceWrite,
                     java.lang.String shortDesc,
                     java.lang.String longDesc,
                     LongCallback cb,
                     boolean isSize)

register

public void register(java.lang.String optionName,
                     java.lang.String defaultValueString,
                     int sortOrder,
                     boolean expert,
                     boolean forceWrite,
                     java.lang.String shortDesc,
                     java.lang.String longDesc,
                     IntCallback cb)

Registers a bandwidth option.

See Also:

BandwidthOption

register

public void register(java.lang.String optionName,
                     boolean defaultValue,
                     int sortOrder,
                     boolean expert,
                     boolean forceWrite,
                     java.lang.String shortDesc,
                     java.lang.String longDesc,
                     BooleanCallback cb)

register

public void register(java.lang.String optionName,
                     java.lang.String defaultValue,
                     int sortOrder,
                     boolean expert,
                     boolean forceWrite,
                     java.lang.String shortDesc,
                     java.lang.String longDesc,
                     StringCallback cb)

register

public void register(java.lang.String optionName,
                     short defaultValue,
                     int sortOrder,
                     boolean expert,
                     boolean forceWrite,
                     java.lang.String shortDesc,
                     java.lang.String longDesc,
                     ShortCallback cb,
                     boolean isSize)

register

public void register(java.lang.String optionName,
                     java.lang.String[] defaultValue,
                     int sortOrder,
                     boolean expert,
                     boolean forceWrite,
                     java.lang.String shortDesc,
                     java.lang.String longDesc,
                     StringArrCallback cb)

getInt

public int getInt(java.lang.String optionName)

getLong

public long getLong(java.lang.String optionName)

getBoolean

public boolean getBoolean(java.lang.String optionName)

getString

public java.lang.String getString(java.lang.String optionName)

getStringArr

public java.lang.String[] getStringArr(java.lang.String optionName)

getShort

public short getShort(java.lang.String optionName)

removeOption

public Option<?> removeOption(java.lang.String optionName)

hasFinishedInitialization

public boolean hasFinishedInitialization()

Has the object we are attached to finished initialization?

finishedInitialization

public void finishedInitialization()

Called when the object we are attached to has finished init. After this point, the callbacks are authoritative for values of config variables, and will be called when values are changed by the user.

setOptions

public void setOptions(SimpleFieldSet sfs)

Set options from a SimpleFieldSet. Once we process an option, we must remove it.

exportFieldSet

public SimpleFieldSet exportFieldSet()

exportFieldSet

public SimpleFieldSet exportFieldSet(boolean withDefaults)

exportFieldSet

public SimpleFieldSet exportFieldSet(Config.RequestType configRequestType,
                                     boolean withDefaults)

forceUpdate

public void forceUpdate(java.lang.String optionName)
                 throws InvalidConfigValueException,
                        NodeNeedRestartException

Force an option to be updated even if it hasn't changed.

Throws:

InvalidConfigValueException

NodeNeedRestartException

set

public void set(java.lang.String name,
                java.lang.String value)
         throws InvalidConfigValueException,
                NodeNeedRestartException

Throws:

InvalidConfigValueException

NodeNeedRestartException

set

public void set(java.lang.String name,
                boolean value)
         throws InvalidConfigValueException,
                NodeNeedRestartException

Throws:

InvalidConfigValueException

NodeNeedRestartException

fixOldDefault

public void fixOldDefault(java.lang.String name,
                          java.lang.String value)

If the option's value is equal to the provided old default, then set it to the new default. Used to deal with changes to important options where this is not handled automatically because the option's value is written to the .ini.

Parameters:

name - The name of the option.

value - The value of the option.

fixOldDefaultRegex

public void fixOldDefaultRegex(java.lang.String name,
                               java.lang.String value)

If the option's value matches the provided old default regex, then set it to the new default. Used to deal with changes to important options where this is not handled automatically because the option's value is written to the .ini.

Parameters:

name - The name of the option.

value - The value of the option.

getPrefix

public java.lang.String getPrefix()

compareTo

public int compareTo(SubConfig second)

Specified by:

compareTo in interface java.lang.Comparable<SubConfig>

getRawOption

public java.lang.String getRawOption(java.lang.String name)