|
FreeHEP API Version 3.2.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
User level interface to a Tree. All paths follow unix convention .., ., /, backslash is the escape character. Relative paths are allowed. NOTE: - this tree keeps a current position(pwd) within the tree. This may be implemented on a per-thread basis.
| Method Summary | |
void |
cd(String path)
Change to a given directory. |
void |
close()
Closes the underlying store. |
void |
commit()
Commit any open transaction to the underlying store(s). |
void |
cp(String oldPath,
String newPath)
Copy an object from a path to another. |
void |
cp(String oldPath,
String newPath,
boolean recursive)
Copy an object from a path to another. |
IManagedObject |
find(String path)
Get the IManagedObject at a given path in the ITree. |
String |
findPath(IManagedObject object)
Get the full path of an IManagedObject. |
ITree |
findTree(String path)
Get a mounted ITree at a given path in the current ITree. |
String[] |
listObjectNames()
Get the list of names of the IManagedObjects under a given path, including directories (but not "." and ".."). |
String[] |
listObjectNames(String path)
Get the list of names of the IManagedObjects under a given path, including directories (but not "." and ".."). |
String[] |
listObjectNames(String path,
boolean recursive)
Get the list of names of the IManagedObjects under a given path, including directories (but not "." and ".."). |
String[] |
listObjectTypes()
Get the list of types of the IManagedObjects under a given path. |
String[] |
listObjectTypes(String path)
Get the list of types of the IManagedObjects under a given path. |
String[] |
listObjectTypes(String path,
boolean recursive)
Get the list of types of the IManagedObjects under a given path. |
void |
ls()
List, into a given output stream, all the IManagedObjects, including directories (but not "." and ".."), in a given path. |
void |
ls(String path)
List, into a given output stream, all the IManagedObjects, including directories (but not "." and ".."), in a given path. |
void |
ls(String path,
boolean recursive)
List, into a given output stream, all the IManagedObjects, including directories (but not "." and ".."), in a given path. |
void |
ls(String path,
boolean recursive,
OutputStream os)
List, into a given output stream, all the IManagedObjects, including directories (but not "." and ".."), in a given path. |
void |
mkdir(String path)
Create a new directory. |
void |
mkdirs(String path)
Create a directory recursively. |
void |
mount(String path,
ITree tree,
String treePath)
Mounts a tree within another (target) tree. |
void |
mv(String oldPath,
String newPath)
Move an IManagedObject or a directory from one directory to another. |
String |
pwd()
Get the path of the current working directory. |
void |
rm(String path)
Remove an IManagedObject by specifying its path. |
void |
rmdir(String path)
Remove a directory and all the contents underneeth. |
void |
setOverwrite()
Set the strategy of what should happen if two objects have the same path. |
void |
setOverwrite(boolean overwrite)
Set the strategy of what should happen if two objects have the same path. |
String |
storeName()
Get the name of the store. |
void |
symlink(String path,
String alias)
Create a symbolic link to an object in the ITree. |
void |
unmount(String path)
Unmount a subtree at a given path (mount point). |
| Method Detail |
public String storeName()
public IManagedObject find(String path)
throws IllegalArgumentException
path - The path.
IllegalArgumentException - If the path does not correspond to an IManagedObject.
public ITree findTree(String path)
throws IllegalArgumentException
path - The path.
IllegalArgumentException - If the path does not correspond to an ITree.
public void cd(String path)
throws IllegalArgumentException
path - The absolute or relative path of the directory we are changing to.
IllegalArgumentException - If the path does not exist.public String pwd()
public void ls()
throws IllegalArgumentException
false.
IllegalArgumentException - If the path does not exist.
public void ls(String path)
throws IllegalArgumentException
path - The path where the list has to be performed (by default the current directory ".").
in all the directories under path (the default is false.
IllegalArgumentException - If the path does not exist.
public void ls(String path,
boolean recursive)
throws IllegalArgumentException
path - The path where the list has to be performed (by default the current directory ".").recursive - If true the list is extended recursively
in all the directories under path (the default is false.
IllegalArgumentException - If the path does not exist.
public void ls(String path,
boolean recursive,
OutputStream os)
throws IllegalArgumentException
path - The path where the list has to be performed (by default the current directory ".").recursive - If true the list is extended recursively
in all the directories under path (the default is false.os - The output stream into which the list is dumped (by default the standard output).
IllegalArgumentException - If the path does not exist.
public String[] listObjectNames()
throws IllegalArgumentException
false.
IllegalArgumentException - If the path does not exist.
public String[] listObjectNames(String path)
throws IllegalArgumentException
path - The path where the list has to be performed (by default the current directory ".").
in all the directories under path (the default is false.
IllegalArgumentException - If the path does not exist.
public String[] listObjectNames(String path,
boolean recursive)
throws IllegalArgumentException
path - The path where the list has to be performed (by default the current directory ".").recursive - If true the list is extended recursively
in all the directories under path (the default is false.
IllegalArgumentException - If the path does not exist.
public String[] listObjectTypes()
throws IllegalArgumentException
false.
IllegalArgumentException - If the path does not exist.
public String[] listObjectTypes(String path)
throws IllegalArgumentException
path - The path where the list has to be performed (by default the current directory ".").
in all the directories under path (the default is false.
IllegalArgumentException - If the path does not exist.
public String[] listObjectTypes(String path,
boolean recursive)
throws IllegalArgumentException
path - The path where the list has to be performed (by default the current directory ".").recursive - If true the list is extended recursively
in all the directories under path (the default is false.
IllegalArgumentException - If the path does not exist.
public void mkdir(String path)
throws IllegalArgumentException
path - The absolute or relative path of the new directory.
IllegalArgumentException - If a subdirectory within the path does
not exist or it is not a directory. Also if the directory already exists.
public void mkdirs(String path)
throws IllegalArgumentException
path - The absolute or relative path of the new directory.
IllegalArgumentException - If an intermediate subdirectory
is not a directory, or if the directory already exists.
public void rmdir(String path)
throws IllegalArgumentException
path - The absolute or relative path of the directory to be removed.
IllegalArgumentException - If path does not exist or if it is not
a directory.
public void rm(String path)
throws IllegalArgumentException
path - The absolute or relative path of the IManagedObject to be removed.
IllegalArgumentException - If path does not exist.
public String findPath(IManagedObject object)
throws IllegalArgumentException
object - The IManagedObject whose path is to be returned.
IllegalArgumentException - If the IManagedObject does not exist.
public void mv(String oldPath,
String newPath)
throws IllegalArgumentException
oldPath - The path of the IManagedObject or direcoty to be moved.newPath - The path of the diretory in which the object has to be moved to.
IllegalArgumentException - If either path does not exist.
public void commit()
throws IOException
IOException - If the underlying store cannot be written out.public void setOverwrite()
public void setOverwrite(boolean overwrite)
overwrite - true to enable overwriting.
public void cp(String oldPath,
String newPath)
throws IllegalArgumentException
oldPath - The path of the object to be copied.newPath - The path where the object is to be copied.
IllegalArgumentException - If either path does not exist.
public void cp(String oldPath,
String newPath,
boolean recursive)
throws IllegalArgumentException
oldPath - The path of the object to be copied.newPath - The path where the object is to be copied.recursive - true if a recursive copy has to be performed.
IllegalArgumentException - If either path does not exist.
public void symlink(String path,
String alias)
throws IllegalArgumentException
path - The absolute or relative path of the object to be linked.alias - The absolute or relative name of the link.
IllegalArgumentException - If path or any
subidrectory within path does not exist.
public void mount(String path,
ITree tree,
String treePath)
throws IllegalArgumentException
target.mount("/home/tonyj",tree,"/");
path - The path in the target treetree - The tree to mount within the target treetreePath - The mount point within the tree to be mounted.
IllegalArtumentException - If something does not exist.
IllegalArgumentException
public void unmount(String path)
throws IllegalArgumentException
path - The path of the subtree to be unmounted.
IllegalArgumentException - If path does not exist.
public void close()
throws IOException
IOException - If there are problems writing out
the underlying store.
|
FreeHEP API Version 3.2.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||