com.goldencode.p2j.directory

Class NullDirectory

java.lang.Object

com.goldencode.p2j.directory.NullDirectory

All Implemented Interfaces:

Directory

public class NullDirectory
extends java.lang.Object
implements Directory

Provides a safe placeholder that simply returns the initial value (there is no directory lookup).

Field Summary

Fields inherited from interface com.goldencode.p2j.directory.Directory

ID_ABSOLUTE, ID_RELATIVE, ID_RELATIVE_ACCOUNT, ID_RELATIVE_BOTH, ID_RELATIVE_SERVER

Constructor Summary

Constructors

Constructor and Description
NullDirectory()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	enumerateNodes(int search, java.lang.String id) Enumerates nodes from the directory as specified by the given absolute or relative node ID.
boolean	getBoolean(int search, java.lang.String id, boolean initial) Access a data value from the directory as specified by the given absolute or relative node ID.
java.lang.Boolean	getBoolean(int search, java.lang.String id, java.lang.Boolean initial) Access a data value from the directory as specified by the given absolute or relative node ID.
char	getChar(int search, java.lang.String id, char initial) Access a data value from the directory as specified by the given absolute or relative node ID.
double	getDouble(int search, java.lang.String id, double initial) Access a data value from the directory as specified by the given absolute or relative node ID.
int	getInt(int search, java.lang.String id, int initial) Access a data value from the directory as specified by the given absolute or relative node ID.
java.lang.String	getString(int search, java.lang.String id, java.lang.String initial) Access a data value from the directory as specified by the given absolute or relative node ID.
java.util.List<java.lang.String>	getStrings(int search, java.lang.String id) Get all String attribute values from the directory as specified by the given absolute or relative node ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullDirectory

public NullDirectory()

Method Detail

getString

public java.lang.String getString(int search,
                                  java.lang.String id,
                                  java.lang.String initial)

Access a data value from the directory as specified by the given absolute or relative node ID.

Specified by:

getString in interface Directory

Parameters:

search - Must be one of ID_ABSOLUTE (if the given node ID includes all paths from the root of the directory tree to the node being read) or ID_RELATIVE if the given ID is only a relative portion which should be found via a search through a standard set of search paths.

id - The node ID to retrieve.

initial - The initial value to return if a node of the proper type is not found by the given node ID or if no node is found by the given node ID.

Returns:

The data value at that node ID or the default initial value.

getStrings

public java.util.List<java.lang.String> getStrings(int search,
                                                   java.lang.String id)

Get all String attribute values from the directory as specified by the given absolute or relative node ID.

Specified by:

getStrings in interface Directory

Parameters:

search - Must be one of ID_ABSOLUTE (if the given node ID includes all paths from the root of the directory tree to the node being read) or ID_RELATIVE if the given ID is only a relative portion which should be found via a search through a standard set of search paths.

id - The node ID to retrieve.

Returns:

List of attribute values at that node ID or an empty list.

getChar

public char getChar(int search,
                    java.lang.String id,
                    char initial)

Access a data value from the directory as specified by the given absolute or relative node ID.

Specified by:

getChar in interface Directory

Parameters:

search - Must be one of ID_ABSOLUTE (if the given node ID includes all paths from the root of the directory tree to the node being read) or ID_RELATIVE if the given ID is only a relative portion which should be found via a search through a standard set of search paths.

id - The node ID to retrieve.

initial - The initial value to return if a node of the proper type is not found by the given node ID or if no node is found by the given node ID.

Returns:

The data value at that node ID or the default initial value.

getInt

public int getInt(int search,
                  java.lang.String id,
                  int initial)

Access a data value from the directory as specified by the given absolute or relative node ID.

Specified by:

getInt in interface Directory

Parameters:

search - Must be one of ID_ABSOLUTE (if the given node ID includes all paths from the root of the directory tree to the node being read) or ID_RELATIVE if the given ID is only a relative portion which should be found via a search through a standard set of search paths.

id - The node ID to retrieve.

initial - The initial value to return if a node of the proper type is not found by the given node ID or if no node is found by the given node ID.

Returns:

The data value at that node ID or the default initial value.

getDouble

public double getDouble(int search,
                        java.lang.String id,
                        double initial)

Access a data value from the directory as specified by the given absolute or relative node ID.

Specified by:

getDouble in interface Directory

Parameters:

search - Must be one of ID_ABSOLUTE (if the given node ID includes all paths from the root of the directory tree to the node being read) or ID_RELATIVE if the given ID is only a relative portion which should be found via a search through a standard set of search paths.

id - The node ID to retrieve.

initial - The initial value to return if a node of the proper type is not found by the given node ID or if no node is found by the given node ID.

Returns:

The data value at that node ID or the default initial value.

getBoolean

public boolean getBoolean(int search,
                          java.lang.String id,
                          boolean initial)

Access a data value from the directory as specified by the given absolute or relative node ID.

Specified by:

getBoolean in interface Directory

Parameters:

search - Must be one of ID_ABSOLUTE (if the given node ID includes all paths from the root of the directory tree to the node being read) or ID_RELATIVE if the given ID is only a relative portion which should be found via a search through a standard set of search paths.

id - The node ID to retrieve.

initial - The initial value to return if a node of the proper type is not found by the given node ID or if no node is found by the given node ID.

Returns:

The data value at that node ID or the default initial value.

getBoolean

public java.lang.Boolean getBoolean(int search,
                                    java.lang.String id,
                                    java.lang.Boolean initial)

Access a data value from the directory as specified by the given absolute or relative node ID.

Specified by:

getBoolean in interface Directory

Parameters:

search - Must be one of ID_ABSOLUTE (if the given node ID includes all paths from the root of the directory tree to the node being read) or ID_RELATIVE if the given ID is only a relative portion which should be found via a search through a standard set of search paths.

id - The node ID to retrieve.

initial - The initial value to return if a node of the proper type is not found by the given node ID or if no node is found by the given node ID.

Returns:

The data value at that node ID or the default initial value.

enumerateNodes

public java.util.List<java.lang.String> enumerateNodes(int search,
                                                       java.lang.String id)

Enumerates nodes from the directory as specified by the given absolute or relative node ID.

Specified by:

enumerateNodes in interface Directory

Parameters:

search - Must be one of ID_ABSOLUTE (if the given node ID includes all paths from the root of the directory tree to the node being read) or ID_RELATIVE if the given ID is only a relative portion which should be found via a search through a standard set of search paths.

id - The node ID to retrieve.

Returns:

The list od node ids or an empty list if no nodes found.