public interface Directory
Modifier and Type | Field and Description |
---|---|
static int |
ID_ABSOLUTE
The node ID includes the full path from the root.
|
static int |
ID_RELATIVE
Node ID is relative to a default set of account search paths for compatibility reasons.
|
static int |
ID_RELATIVE_ACCOUNT
Node ID is relative to a default set of account search paths.
|
static int |
ID_RELATIVE_BOTH
Node ID is relative to a default set of account and server search paths.
|
static int |
ID_RELATIVE_SERVER
Node ID is relative to a default set of server search paths.
|
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.
|
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. |
static final int ID_ABSOLUTE
static final int ID_RELATIVE
static final int ID_RELATIVE_ACCOUNT
static final int ID_RELATIVE_SERVER
static final int ID_RELATIVE_BOTH
java.lang.String getString(int search, java.lang.String id, java.lang.String initial)
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.java.util.List<java.lang.String> getStrings(int search, java.lang.String id)
String
attribute values from the directory as specified
by the given absolute or relative node ID.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.char getChar(int search, java.lang.String id, char initial)
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.int getInt(int search, java.lang.String id, int initial)
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.double getDouble(int search, java.lang.String id, double initial)
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.boolean getBoolean(int search, java.lang.String id, boolean initial)
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.java.util.List<java.lang.String> enumerateNodes(int search, java.lang.String id)
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.