DirectorySubspace (FoundationDB Java Client API)

java.lang.Object
- com.foundationdb.subspace.Subspace
- - com.foundationdb.directory.DirectorySubspace

All Implemented Interfaces:

Directory
```
public class DirectorySubspace
extends Subspace
implements Directory
```
A DirectorySubspace represents the contents of a directory, but it also remembers the path with which it was opened and offers convenience methods to operate on the directory at that path.
An instance of DirectorySubspace can be used for all the usual subspace operations. It can also be used to operate on the directory with which it was opened.

Method Summary

Methods
Modifier and Type	Method and Description
`Future<DirectorySubspace>`	`create(TransactionContext tcx, List<String> subpath)` Creates a subdirectory of this `Directory` located at `subpath` (creating parent directories if necessary).
`Future<DirectorySubspace>`	`create(TransactionContext tcx, List<String> subpath, byte[] otherLayer)` Creates a subdirectory of this `Directory` located at `subpath` (creating parent directories if necessary).
`Future<DirectorySubspace>`	`create(TransactionContext tcx, List<String> subpath, byte[] otherLayer, byte[] prefix)` Creates a subdirectory of this `Directory` located at `subpath` (creating parent directories if necessary).
`Future<DirectorySubspace>`	`createOrOpen(TransactionContext tcx, List<String> subpath)` Creates or opens the subdirectory of this `Directory` located at `subpath` (creating parent directories, if necessary).
`Future<DirectorySubspace>`	`createOrOpen(TransactionContext tcx, List<String> subpath, byte[] otherLayer)` Creates or opens the subdirectory of this `Directory` located at `subpath` (creating parent directories, if necessary).
`boolean`	`equals(Object rhs)` Returns whether this `DirectorySubspace` is equal to `rhs`.
`Future<Boolean>`	`exists(ReadTransactionContext tcx)` Checks if this `Directory` exists.
`Future<Boolean>`	`exists(ReadTransactionContext tcx, List<String> subpath)` Checks if the subdirectory of this `Directory` located at `subpath` exists.
`DirectoryLayer`	`getDirectoryLayer()` Get the `DirectoryLayer` that was used to create this `Directory`.
`byte[]`	`getLayer()` Gets the layer byte string that was stored when this `Directory` was created.
`List<String>`	`getPath()` Gets the path represented by this `Directory`.
`Future<List<String>>`	`list(ReadTransactionContext tcx)` List the subdirectories of this directory.
`Future<List<String>>`	`list(ReadTransactionContext tcx, List<String> subpath)` List the subdirectories of this directory at a given `subpath`.
`Future<DirectorySubspace>`	`move(TransactionContext tcx, List<String> oldSubpath, List<String> newSubpath)` Moves the subdirectory of this `Directory` located at `oldSubpath` to `newSubpath`.
`Future<DirectorySubspace>`	`moveTo(TransactionContext tcx, List<String> newAbsolutePath)` Moves this `Directory` to the specified `newAbsolutePath`.
`Future<DirectorySubspace>`	`open(ReadTransactionContext tcx, List<String> subpath)` Opens the subdirectory of this `Directory` located at `subpath`.
`Future<DirectorySubspace>`	`open(ReadTransactionContext tcx, List<String> subpath, byte[] otherLayer)` Opens the subdirectory of this `Directory` located at `subpath`.
`Future<Void>`	`remove(TransactionContext tcx)` Removes this `Directory` and all of its subdirectories, as well as all of their contents.
`Future<Void>`	`remove(TransactionContext tcx, List<String> subpath)` Removes the subdirectory of this `Directory` located at `subpath` and all of its subdirectories, as well as all of their contents.
`Future<Boolean>`	`removeIfExists(TransactionContext tcx)` Removes this `Directory` and all of its subdirectories, as well as all of their contents.
`Future<Boolean>`	`removeIfExists(TransactionContext tcx, List<String> subpath)` Removes the subdirectory of this `Directory` located at `subpath` and all of its subdirectories, as well as all of their contents.
`String`	`toString()`

Methods inherited from class com.foundationdb.subspace.Subspace
contains, get, get, getKey, pack, pack, pack, range, range, subspace, unpack

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Subspace
    
    Returns:
    a printable representation of this DirectorySubspace
  - equals
```
public boolean equals(Object rhs)
```
    Returns whether this DirectorySubspace is equal to rhs. Two DirectorySubspaces are equal if they were created by the same DirectoryLayer and have the same path, layer, and subspace prefix.
    
    Overrides:
    
    equals in class Subspace
    
    Parameters:
    rhs - the Object to test for equality
    
    Returns:
    true if this is equal to rhs
  - getPath
```
public List<String> getPath()
```
    Description copied from interface: Directory
    
    Gets the path represented by this Directory.
    
    Specified by:
    
    getPath in interface Directory
    
    Returns:
    this Directory's path
  - getLayer
```
public byte[] getLayer()
```
    Description copied from interface: Directory
    
    Gets the layer byte string that was stored when this Directory was created.
    
    Specified by:
    
    getLayer in interface Directory
    
    Returns:
    this Directory's layer byte string
  - getDirectoryLayer
```
public DirectoryLayer getDirectoryLayer()
```
    Description copied from interface: Directory
    
    Get the DirectoryLayer that was used to create this Directory.
    
    Specified by:
    
    getDirectoryLayer in interface Directory
    
    Returns:
    the DirectoryLayer that created this Directory
  - createOrOpen
```
public Future<DirectorySubspace> createOrOpen(TransactionContext tcx,
                                     List<String> subpath)
```
    Description copied from interface: Directory
    
    Creates or opens the subdirectory of this Directory located at subpath (creating parent directories, if necessary).
    
    Specified by:
    
    createOrOpen in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    subpath - a List<String> specifying a subpath of this Directory
    
    Returns:
    a Future which will be set to the created or opened DirectorySubspace
  - createOrOpen
```
public Future<DirectorySubspace> createOrOpen(TransactionContext tcx,
                                     List<String> subpath,
                                     byte[] otherLayer)
```
    Description copied from interface: Directory
    Creates or opens the subdirectory of this Directory located at subpath (creating parent directories, if necessary). If the directory is new, then the layer byte string will be recorded as its layer. If the directory already exists, the layer byte string will be compared against the layer set when the directory was created.
    The returned Future can be set to the following errors:
    - MismatchedLayerException - if the directory has already been created with a different layer byte string
    Specified by:
    
    createOrOpen in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    subpath - a List<String> specifying a subpath of this Directory
    otherLayer - a byte[] specifying a layer to set on a new directory or check for on an existing directory
    
    Returns:
    a Future which will be set to the created or opened DirectorySubspace
  - open
```
public Future<DirectorySubspace> open(ReadTransactionContext tcx,
                             List<String> subpath)
```
    Description copied from interface: Directory
    Opens the subdirectory of this Directory located at subpath.
    The returned Future can be set to the following errors:
    - NoSuchDirectoryException - if the directory does not exist
    Specified by:
    
    open in interface Directory
    
    Parameters:
    tcx - the ReadTransactionContext to execute this operation in
    subpath - a List<String> specifying a subpath of this Directory
    
    Returns:
    a Future which will be set to the opened DirectorySubspace
  - open
```
public Future<DirectorySubspace> open(ReadTransactionContext tcx,
                             List<String> subpath,
                             byte[] otherLayer)
```
    Description copied from interface: Directory
    Opens the subdirectory of this Directory located at subpath. The layer byte string will be compared against the layer set when the directory was created.
    The returned Future can be set to the following errors:
    - MismatchedLayerException - if the directory was created with a different layer byte string
    - NoSuchDirectoryException - if the directory does not exist
    Specified by:
    
    open in interface Directory
    
    Parameters:
    tcx - the ReadTransactionContext to execute this operation in
    subpath - a List<String> specifying a subpath of this Directory
    otherLayer - a byte[] specifying the expected layer
    
    Returns:
    a Future which will be set to the opened DirectorySubspace
  - create
```
public Future<DirectorySubspace> create(TransactionContext tcx,
                               List<String> subpath)
```
    Description copied from interface: Directory
    Creates a subdirectory of this Directory located at subpath (creating parent directories if necessary).
    The returned Future can be set to the following errors:
    - DirectoryAlreadyExistsException - if the given directory already exists
    Specified by:
    
    create in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    subpath - a List<String> specifying a subpath of this Directory
    
    Returns:
    a Future which will be set to the created DirectorySubspace
  - create
```
public Future<DirectorySubspace> create(TransactionContext tcx,
                               List<String> subpath,
                               byte[] otherLayer)
```
    Description copied from interface: Directory
    Creates a subdirectory of this Directory located at subpath (creating parent directories if necessary). The layer byte string will be recorded as the new directory's layer and checked by future calls to Directory.open(ReadTransactionContext, List, byte[]).
    The returned Future can be set to the following errors:
    - DirectoryAlreadyExistsException - if the given directory already exists
    Specified by:
    
    create in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    subpath - a List<String> specifying a subpath of this Directory
    otherLayer - a byte[] specifying a layer to set for the directory
    
    Returns:
    a Future which will be set to the created DirectorySubspace
  - create
```
public Future<DirectorySubspace> create(TransactionContext tcx,
                               List<String> subpath,
                               byte[] otherLayer,
                               byte[] prefix)
```
    Description copied from interface: Directory
    Creates a subdirectory of this Directory located at subpath (creating parent directories if necessary). The layer byte string will be recorded as the new directory's layer and checked by future calls to Directory.open(ReadTransactionContext, List, byte[]). The specified prefix will be used for this directory's contents instead of allocating a prefix automatically.
    The returned Future can be set to the following errors:
    - DirectoryAlreadyExistsException - if the given directory already exists
    Specified by:
    
    create in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    subpath - a List<String> specifying a subpath of this Directory
    otherLayer - a byte[] specifying a layer to set for the directory
    prefix - a byte[] specifying the key prefix to use for the directory's contents
    
    Returns:
    a Future which will be set to the created DirectorySubspace
  - list
```
public Future<List<String>> list(ReadTransactionContext tcx)
```
    Description copied from interface: Directory
    List the subdirectories of this directory.
    The returned Future can be set to the following errors:
    - NoSuchDirectoryException - if this Directory doesn't exists
    Specified by:
    
    list in interface Directory
    
    Parameters:
    tcx - the ReadTransactionContext to execute this operation in
    
    Returns:
    a Future which will be set to a List<String> of names of the subdirectories of this Directory. Each name is a unicode string representing the last component of a subdirectory's path.
  - list
```
public Future<List<String>> list(ReadTransactionContext tcx,
                        List<String> subpath)
```
    Description copied from interface: Directory
    List the subdirectories of this directory at a given subpath.
    The returned Future can be set to the following errors:
    - NoSuchDirectoryException - if no directory exists at subpath
    Specified by:
    
    list in interface Directory
    
    Parameters:
    tcx - the ReadTransactionContext to execute this operation in
    subpath - a List<String> specifying a subpath of this Directory
    
    Returns:
    a Future which will be set to a List<String> of names of the subdirectories of the directory at subpath. Each name is a unicode string representing the last component of a subdirectory's path.
  - move
```
public Future<DirectorySubspace> move(TransactionContext tcx,
                             List<String> oldSubpath,
                             List<String> newSubpath)
```
    Description copied from interface: Directory
    Moves the subdirectory of this Directory located at oldSubpath to newSubpath.
    There is no effect on the physical prefix of the given directory, or on clients that already have the directory open.
    
    It is invalid to move a directory to:
    - A location where a directory already exists
    - A location whose parent does not exist
    - A subdirectory of itself
    - A different partition
    The returned Future can be set to the following errors:
    - NoSuchDirectoryException - if no Directory exists at oldSubpath
    - DirectoryAlreadyExistsException - if a directory already exists at newSubpath
    - DirectoryMoveException - if an invalid move location is specified
    Specified by:
    
    move in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    oldSubpath - a List<String> specifying the subpath of the directory to move
    newSubpath - a List<String> specifying the subpath to move to
    
    Returns:
    a Future which will be set to the DirectorySubspace for this Directory at its new location.
  - moveTo
```
public Future<DirectorySubspace> moveTo(TransactionContext tcx,
                               List<String> newAbsolutePath)
```
    Description copied from interface: Directory
    Moves this Directory to the specified newAbsolutePath.
    There is no effect on the physical prefix of the given directory, or on clients that already have the directory open.
    
    It is invalid to move a directory to:
    - A location where a directory already exists
    - A location whose parent does not exist
    - A subdirectory of itself
    - A different partition
    The returned Future can be set to the following errors:
    - NoSuchDirectoryException - if this Directory doesn't exist
    - DirectoryAlreadyExistsException - if a directory already exists at newAbsolutePath
    - DirectoryMoveException - if an invalid move location is specified
    Specified by:
    
    moveTo in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    newAbsolutePath - a List<String> specifying the new absolute path for this Directory
    
    Returns:
    a Future which will be set to the DirectorySubspace for this Directory at its new location.
  - remove
```
public Future<Void> remove(TransactionContext tcx)
```
    Description copied from interface: Directory
    Removes this Directory and all of its subdirectories, as well as all of their contents.
    Warning: Clients that have already opened the directory might still insert data into its contents after it is removed.
    
    The returned Future can be set to the following errors:
    - NoSuchDirectoryException - if this Directory doesn't exist
    Specified by:
    
    remove in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    
    Returns:
    a Future which will be set once this Directory has been removed
  - remove
```
public Future<Void> remove(TransactionContext tcx,
                  List<String> subpath)
```
    Description copied from interface: Directory
    Removes the subdirectory of this Directory located at subpath and all of its subdirectories, as well as all of their contents.
    Warning: Clients that have already opened the directory might still insert data into its contents after it is removed.
    
    The returned Future can be set to the following errors:
    - NoSuchDirectoryException - if no directory exists at subpath
    Specified by:
    
    remove in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    subpath - a List<String> specifying a subpath of this Directory
    
    Returns:
    a Future which will be set once the Directory has been removed
  - removeIfExists
```
public Future<Boolean> removeIfExists(TransactionContext tcx)
```
    Description copied from interface: Directory
    
    Removes this Directory and all of its subdirectories, as well as all of their contents.
    Warning: Clients that have already opened the directory might still insert data into its contents after it is removed.
    
    Specified by:
    
    removeIfExists in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    
    Returns:
    a Future which will be set to true once this Directory has been removed, or false if it didn't exist.
  - removeIfExists
```
public Future<Boolean> removeIfExists(TransactionContext tcx,
                             List<String> subpath)
```
    Description copied from interface: Directory
    
    Removes the subdirectory of this Directory located at subpath and all of its subdirectories, as well as all of their contents.
    Warning: Clients that have already opened the directory might still insert data into its contents after it is removed.
    
    Specified by:
    
    removeIfExists in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    subpath - a List<String> specifying a subpath of this Directory
    
    Returns:
    a Future which will be set to true once the Directory has been removed, or false if it didn't exist.
  - exists
```
public Future<Boolean> exists(ReadTransactionContext tcx)
```
    Description copied from interface: Directory
    
    Checks if this Directory exists.
    
    Specified by:
    
    exists in interface Directory
    
    Parameters:
    tcx - the ReadTransactionContext to execute this operation in
    
    Returns:
    a Future which will be set to true if this Directory exists, or false if it doesn't
  - exists
```
public Future<Boolean> exists(ReadTransactionContext tcx,
                     List<String> subpath)
```
    Description copied from interface: Directory
    
    Checks if the subdirectory of this Directory located at subpath exists.
    
    Specified by:
    
    exists in interface Directory
    
    Parameters:
    tcx - the TransactionContext to execute this operation in
    subpath - a List<String> specifying a subpath of this Directory
    
    Returns:
    a Future which will be set to true if the specified subdirectory exists, or false if it doesn't

Class DirectorySubspace

Method Summary

Methods inherited from class com.foundationdb.subspace.Subspace

Methods inherited from class java.lang.Object

Method Detail

toString

equals

getPath

getLayer

getDirectoryLayer

createOrOpen

createOrOpen

open

open

create

create

create

list

list

move

moveTo

remove

remove

removeIfExists

removeIfExists

exists

exists