com.jagacy.util
Class JagacyProperties

java.lang.Object
  extended bycom.jagacy.util.JagacyProperties

public class JagacyProperties
extends java.lang.Object

Properties used by Jagacy.

Author:
Robert M. Preston

Constructor Summary
JagacyProperties(java.lang.String name)
          Creates a JagacyProperties.
 
Method Summary
 java.lang.String get(java.lang.String key)
          Retrieves a String value.
 java.lang.String get(java.lang.String key, java.lang.String def)
          Retrieves a String value.
 boolean getBoolean(java.lang.String key)
          Retrieves a boolean value.
 boolean getBoolean(java.lang.String key, boolean def)
          Retrieves a boolean value.
 int getCardinal(java.lang.String key)
          Retrieves a cardinal number (0, 1, 2, 3, ...)
 int getCardinal(java.lang.String key, int def)
          Retrieves a cardinal number (0, 1, 2, 3, ...)
 int getField(java.lang.String key)
          Retrieves a field number.
 int getField(java.lang.String key, int def)
          Retrieves a field number.
 Key getKey(java.lang.String key)
          Retrieves a key.
 int getOffset(java.lang.String key)
          Retrieves an offset.
 int getOffset(java.lang.String key, int def)
          Retrieves an offset value.
 int getTimeout(java.lang.String key)
          Retrieves a timeout value.
 int getTimeout(java.lang.String key, int def)
          Retrieves a timeout value.
 void set(java.lang.String key, java.lang.String value)
          Sets a key to a value.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JagacyProperties

public JagacyProperties(java.lang.String name)
                 throws JagacyException
Creates a JagacyProperties.

Parameters:
name - Session name.
Throws:
JagacyException - If an error occurs.
Method Detail

get

public java.lang.String get(java.lang.String key)
                     throws JagacyException
Retrieves a String value.

Parameters:
key - Property key.
Returns:
Value.
Throws:
JagacyException - If an error occurs.

getCardinal

public int getCardinal(java.lang.String key)
                throws JagacyException
Retrieves a cardinal number (0, 1, 2, 3, ...)

Parameters:
key - Property key.
Returns:
A cardinal number.
Throws:
JagacyException - If an error occurs.

getTimeout

public int getTimeout(java.lang.String key)
               throws JagacyException
Retrieves a timeout value.

Parameters:
key - Property key.
Returns:
Timeout.
Throws:
JagacyException - If an error occurs.

getField

public int getField(java.lang.String key)
             throws JagacyException
Retrieves a field number.

Parameters:
key - Property key.
Returns:
Field number.
Throws:
JagacyException - If an error occurs.

getOffset

public int getOffset(java.lang.String key)
              throws JagacyException
Retrieves an offset.

Parameters:
key - Property key.
Returns:
Offset.
Throws:
JagacyException - If an error occurs.

getBoolean

public boolean getBoolean(java.lang.String key)
                   throws JagacyException
Retrieves a boolean value.

Parameters:
key - Property key.
Returns:
true or false.
Throws:
JagacyException - If an error occurs.

get

public java.lang.String get(java.lang.String key,
                            java.lang.String def)
Retrieves a String value.

Parameters:
key - Property key.
def - Default value.
Returns:
Value if found; default otherwise.

getTimeout

public int getTimeout(java.lang.String key,
                      int def)
Retrieves a timeout value.

Parameters:
key - Property key.
def - Default value.
Returns:
Timeout value if found; default otherwise.

getField

public int getField(java.lang.String key,
                    int def)
Retrieves a field number.

Parameters:
key - Property key.
def - Default value.
Returns:
Field number if found; default otherwise.

getOffset

public int getOffset(java.lang.String key,
                     int def)
Retrieves an offset value.

Parameters:
key - Property key.
def - Default value.
Returns:
Offset value if found; default otherwise.

getCardinal

public int getCardinal(java.lang.String key,
                       int def)
Retrieves a cardinal number (0, 1, 2, 3, ...)

Parameters:
key - Property key.
def - Default value.
Returns:
Cardinal number if found; default otherwise.

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean def)
Retrieves a boolean value.

Parameters:
key - Property key.
def - Default value.
Returns:
Boolean value if found; default otherwise.

getKey

public Key getKey(java.lang.String key)
           throws JagacyException
Retrieves a key.

Parameters:
key - Property key (see Key for valid names).
Returns:
A key.
Throws:
JagacyException - If an error occurs.
See Also:
Key

set

public void set(java.lang.String key,
                java.lang.String value)
Sets a key to a value.

Parameters:
key - Property key.
value - Value.