org.basex.core

Class AProp

java.lang.Object

org.basex.core.AProp

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>

Direct Known Subclasses:

GUIProp, HTMLProp, MainProp, ParserProp, Prop, SerializerProp

public abstract class AProp
extends java.lang.Object
implements java.lang.Iterable<java.lang.String>

This class assembles properties which are used all around the project. They are initially read from and finally written to disk.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.TreeMap<java.lang.String,java.lang.Object>	props Properties.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AProp() Constructor, initializing the default options.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	get(java.lang.Object[] key) Returns the requested string.
java.lang.Object	get(java.lang.String key) Returns the requested object, or null.
boolean	invert(java.lang.Object[] key) Inverts a boolean property.
boolean	is(java.lang.Object[] key) Returns the requested boolean.
java.util.Iterator<java.lang.String>	iterator()
int	num(java.lang.Object[] key) Returns the requested integer.
int[]	nums(java.lang.Object[] key) Returns the requested integer array.
protected void	parse(java.lang.String s) Parses a property string and sets the properties accordingly.
protected void	read(java.lang.String prop) Reads the configuration file and initializes the project properties.
boolean	sameAs(java.lang.Object[] key, java.lang.Object val) Checks if the specified property has changed.
void	set(java.lang.Object[] key, boolean val) Assigns the specified boolean for the specified key.
void	set(java.lang.Object[] key, int val) Assigns the specified integer for the specified key.
void	set(java.lang.Object[] key, int[] val) Assigns the specified integer array for the specified key.
void	set(java.lang.Object[] key, java.lang.String val) Assigns the specified value for the specified key.
void	set(java.lang.Object[] key, java.lang.String[] val) Assigns the specified string array for the specified key.
java.lang.String	set(java.lang.String key, java.lang.String val) Sets the specified value after casting it to the correct type.
void	setObject(java.lang.String key, java.lang.Object val) Assigns the specified object for the specified key.
java.lang.String	similar(java.lang.String key) Returns a key similar to the specified string, or null.
java.lang.String[]	strings(java.lang.Object[] key) Returns the requested string array.
java.lang.String	toString()
java.lang.String	unknown(java.lang.String key) Returns an error string for an unknown key.
void	write() Writes the properties to disk.

Methods inherited from class java.lang.Object

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

Field Detail

props

protected final java.util.TreeMap<java.lang.String,java.lang.Object> props

Properties.

Constructor Detail

AProp

protected AProp()

Constructor, initializing the default options.

Method Detail

read

protected void read(java.lang.String prop)

Reads the configuration file and initializes the project properties. The file is located in the project home directory.

Parameters:

prop - property file extension

write

public final void write()

Writes the properties to disk.

get

public final java.lang.Object get(java.lang.String key)

Returns the requested object, or null.

Parameters:

key - key to be found

Returns:

value

get

public final java.lang.String get(java.lang.Object[] key)

Returns the requested string.

Parameters:

key - key to be found

Returns:

value

num

public final int num(java.lang.Object[] key)

Returns the requested integer.

Parameters:

key - key to be found

Returns:

value

is

public final boolean is(java.lang.Object[] key)

Returns the requested boolean.

Parameters:

key - key to be found

Returns:

value

strings

public final java.lang.String[] strings(java.lang.Object[] key)

Returns the requested string array.

Parameters:

key - key to be found

Returns:

value

nums

public final int[] nums(java.lang.Object[] key)

Returns the requested integer array.

Parameters:

key - key to be found

Returns:

value

set

public final void set(java.lang.Object[] key,
       java.lang.String val)

Assigns the specified value for the specified key.

Parameters:

key - key to be found

val - value to be written

set

public final void set(java.lang.Object[] key,
       int val)

Assigns the specified integer for the specified key.

Parameters:

key - key to be found

val - value to be written

set

public final void set(java.lang.Object[] key,
       boolean val)

Assigns the specified boolean for the specified key.

Parameters:

key - key to be found

val - value to be written

set

public final void set(java.lang.Object[] key,
       java.lang.String[] val)

Assigns the specified string array for the specified key.

Parameters:

key - key to be found

val - value to be written

set

public final void set(java.lang.Object[] key,
       int[] val)

Assigns the specified integer array for the specified key.

Parameters:

key - key to be found

val - value to be written

setObject

public final void setObject(java.lang.String key,
             java.lang.Object val)

Assigns the specified object for the specified key.

Parameters:

key - key to be found

val - value to be written

set

public final java.lang.String set(java.lang.String key,
                   java.lang.String val)

Sets the specified value after casting it to the correct type.

Parameters:

key - key

val - value

Returns:

final value, or null if the key has not been found

parse

protected final void parse(java.lang.String s)
                    throws java.io.IOException

Parses a property string and sets the properties accordingly.

Parameters:

s - property string

Throws:

java.io.IOException - io exception

unknown

public final java.lang.String unknown(java.lang.String key)

Returns an error string for an unknown key.

Parameters:

key - key

Returns:

error string

invert

public final boolean invert(java.lang.Object[] key)

Inverts a boolean property.

Parameters:

key - key

Returns:

new value

sameAs

public final boolean sameAs(java.lang.Object[] key,
             java.lang.Object val)

Checks if the specified property has changed.

Parameters:

key - key

val - new value

Returns:

result of check

similar

public final java.lang.String similar(java.lang.String key)

Returns a key similar to the specified string, or null.

Parameters:

key - key to be found

Returns:

similar key

iterator

public final java.util.Iterator<java.lang.String> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object