DistributedTreeAdapter (galaxy 1.4 API)

java.lang.Object
- co.paralleluniverse.galaxy.cluster.DistributedTreeAdapter

All Implemented Interfaces:: DistributedTree

public class DistributedTreeAdapter
extends Object
implements DistributedTree

Nested Class Summary
- Nested classes/interfaces inherited from interface co.paralleluniverse.galaxy.cluster.DistributedTree
  DistributedTree.Listener, DistributedTree.ListenerAdapter

Constructor Summary

Constructors
Constructor and Description

DistributedTreeAdapter(DistributedTree tree)

Constructors
Constructor and Description
`DistributedTreeAdapter(DistributedTree tree)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addListener(String node, DistributedTree.Listener listener)` Adds a `listener` listening for modifications on the given node.
`void`	`create(String node, boolean ephemeral)` Creates a new node in the tree.
`void`	`createEphemeralOrdered(String node)` Creates an ephemeral node that, when returned by `getChildren()`, will be placed in the list in relation to other ordered ephemeral nodes by the relative order of its creation.
`void`	`delete(String node)` Deletes a node and all its descendents from the tree.
`boolean`	`exists(String node)` Returns `true` if the given node exists in the tree.
`void`	`flush()` Ensures that all updates to the tree done by this cluster node will have been seen by all nodes in the cluster when this method returns.
`byte[]`	`get(String node)` Returns the contents of a given node.
`List<String>`	`getChildren(String node)` Returns all child-nodes (direct descendents) of a given node, with ephemeral ordered nodes returned in the order they were created.
`void`	`print(String node, PrintStream out)` Prints the tree's structure, starting at a given node, to the given stream.
`void`	`removeListener(String node, DistributedTree.Listener listener)` Removes a listener.
`void`	`set(String node, byte[] data)` Associates data with (sets the contents of) a given node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DistributedTreeAdapter
```
public DistributedTreeAdapter(DistributedTree tree)
```
- Method Detail
  - addListener
```
public void addListener(String node,
               DistributedTree.Listener listener)
```
    Description copied from interface: DistributedTree
    
    Adds a listener listening for modifications on the given node. As soon as the listener is added, nodeAdded is called for each child of node.
    
    Specified by:
    
    addListener in interface DistributedTree
    
    Parameters:
    node - The full path of the node to observe.
    listener - The listener.
  - removeListener
```
public void removeListener(String node,
                  DistributedTree.Listener listener)
```
    Description copied from interface: DistributedTree
    
    Removes a listener.
    
    Specified by:
    
    removeListener in interface DistributedTree
    
    Parameters:
    node - The full path of the node the listener is currently observing.
    listener - The listener to remove.
  - create
```
public void create(String node,
          boolean ephemeral)
```
    Description copied from interface: DistributedTree
    
    Creates a new node in the tree. All nonexistent parent nodes are also created (i.e. all nonexistent nodes along the path).
    The node can be ephemeral in which case, it and all its descendents will be deleted automatically when the creating cluster-node (this machine) goes offline, i.e. disconnected from the cluster for whatever reason - intentional or due to some fault. Non-ephemeral (permanent) nodes persist in the tree until the entire cluster is taken down.
    If the node is marked as ephemeral, all nonexistent ancestors that will be created in the process will be ephemeral as well.
    
    Specified by:
    
    create in interface DistributedTree
    
    Parameters:
    node - The full path of the node to create.
    ephemeral - true if the node is to be ephemeral; false if it's to be permanent.
  - createEphemeralOrdered
```
public void createEphemeralOrdered(String node)
```
    Description copied from interface: DistributedTree
    
    Creates an ephemeral node that, when returned by getChildren(), will be placed in the list in relation to other ordered ephemeral nodes by the relative order of its creation. The node's ancestors are not created.
    
    Specified by:
    
    createEphemeralOrdered in interface DistributedTree
    
    Parameters:
    node - The full path of the node to create.
  - set
```
public void set(String node,
       byte[] data)
```
    Description copied from interface: DistributedTree
    
    Associates data with (sets the contents of) a given node.
    
    Specified by:
    
    set in interface DistributedTree
    
    Parameters:
    node - The full path name of the node.
    data - The data to be associated with the node.
    See Also:
    DistributedTree.get(java.lang.String)
  - delete
```
public void delete(String node)
```
    Description copied from interface: DistributedTree
    
    Deletes a node and all its descendents from the tree.
    
    Specified by:
    
    delete in interface DistributedTree
    
    Parameters:
    node - The full path of the node to be removed.
  - flush
```
public void flush()
```
    Description copied from interface: DistributedTree
    
    Ensures that all updates to the tree done by this cluster node will have been seen by all nodes in the cluster when this method returns.
    
    Specified by:
    
    flush in interface DistributedTree
  - exists
```
public boolean exists(String node)
```
    Description copied from interface: DistributedTree
    
    Returns true if the given node exists in the tree.
    
    Specified by:
    
    exists in interface DistributedTree
    
    Parameters:
    node - The full path of the node to test.
    
    Returns:
    true if the given node exists in the tree; false otherwise.
  - get
```
public byte[] get(String node)
```
    Description copied from interface: DistributedTree
    
    Returns the contents of a given node.
    
    Specified by:
    
    get in interface DistributedTree
    
    Parameters:
    node - The full path of the node.
    
    Returns:
    The given node's data contents.
    See Also:
    DistributedTree.set(java.lang.String, byte[])
  - getChildren
```
public List<String> getChildren(String node)
```
    Description copied from interface: DistributedTree
    
    Returns all child-nodes (direct descendents) of a given node, with ephemeral ordered nodes returned in the order they were created.
    
    Specified by:
    
    getChildren in interface DistributedTree
    
    Parameters:
    node - The full path of the node.
    
    Returns:
    A list of the simple names (without the full path) of all of the given node's children.
  - print
```
public void print(String node,
         PrintStream out)
```
    Description copied from interface: DistributedTree
    
    Prints the tree's structure, starting at a given node, to the given stream.
    
    Specified by:
    
    print in interface DistributedTree
    
    Parameters:
    node - The node that will serve as the root of the dump.
    out - The output stream to which the tree structure is to be sent.

Class DistributedTreeAdapter

Nested Class Summary

Nested classes/interfaces inherited from interface co.paralleluniverse.galaxy.cluster.DistributedTree

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DistributedTreeAdapter

Method Detail

addListener

removeListener

create

createEphemeralOrdered

set

delete

flush

exists

get

getChildren

print