Uses of Class de.zib.scalaris.ErlangValue
Date: 2016-02-29

## Uses of Class
de.zib.scalaris.ErlangValue

- Packages that use ErlangValue
  Package | Description
  --- | ---
  de.zib.scalaris | This package contains means to communicate with the erlang scalaris ring from Java.
  de.zib.scalaris.examples | This package contains examples how to use the classes of the `de.zib.scalaris` package.
  de.zib.scalaris.executor |
  de.zib.scalaris.operations |

- - ### Uses of ErlangValue in de.zib.scalaris

    Fields in de.zib.scalaris with type parameters of type ErlangValue
    Modifier and Type | Field and Description
    --- | ---
    `List<ErlangValue>` | ScalarisVM.DeleteNodesByNameResult.`notFound` Nodes which do not exist (anymore) in the VM.
    `List<ErlangValue>` | ScalarisVM.AddNodesResult.`successful` Names of successfully added nodes.
    `List<ErlangValue>` | ScalarisVM.DeleteNodesByNameResult.`successful` Names of successfully deleted nodes.

    Methods in de.zib.scalaris that return ErlangValue
    Modifier and Type | Method and Description
    --- | ---
    `ErlangValue` | KeyChangedException.`getOldValue()` Returns the (old) value stored in scalaris.
    `ErlangValue` | ResultList.`processReadAt(int pos)` Processes the result at the given position which originated from a read request and returns the value that has been read.
    `ErlangValue` | AbstractTransaction.`read(OtpErlangString key)` Gets the value stored under the given `key`.
    `ErlangValue` | AbstractTransaction.`read(String key)` Gets the value stored under the given `key`.

    Methods in de.zib.scalaris that return types with arguments of type ErlangValue
    Modifier and Type | Method and Description
    --- | ---
    `List<ErlangValue>` | ScalarisVM.`getNodes()` Gets the names of the nodes in the Scalaris VM of the current connection.
    `List<ErlangValue>` | ScalarisVM.`killNodes(int number)` Kills the given number of nodes inside the Scalaris VM of the current connection.
    `Collection<ErlangValue>` | ErlangValue.`listCollectionValue(Class<? extends Collection<ErlangValue>> clazz)` Returns a `Collection` of mixed Java values (wrapped in `ErlangValue` objects) of the wrapped erlang value (internally represented as a list in Erlang).
    `List<ErlangValue>` | ErlangValue.`listValue()` Returns a list of mixed Java values (wrapped in `ErlangValue` objects) of the wrapped erlang value.
    `List<ErlangValue>` | ScalarisVM.`shutdownNodes(int number)` Shuts down the given number of nodes (graceful leave) inside the Scalaris VM of the current connection.

    Methods in de.zib.scalaris with parameters of type ErlangValue
    Modifier and Type | Method and Description
    --- | ---
    `int` | ErlangValue.`compareTo(ErlangValue o)` Compares two erlang values by their string representation (expensive!).
    `T` | ErlangValue.ListElementConverter.`convert(int i, ErlangValue v)` Conversion function.
    `String` | ErlangValue.StringListElementConverter.`convert(int i, ErlangValue v)`
    `boolean` | ScalarisVM.`killNode(ErlangValue name)` Kills the given node inside the Scalaris VM of the current connection.
    `boolean` | ScalarisVM.`shutdownNode(ErlangValue name)` Shuts down the given node (graceful leave) inside the Scalaris VM of the current connection.

    Method parameters in de.zib.scalaris with type arguments of type ErlangValue
    Modifier and Type | Method and Description
    --- | ---
    `ScalarisVM.DeleteNodesByNameResult` | ScalarisVM.`killNodes(List<ErlangValue> names)` Kills the given nodes inside the Scalaris VM of the current connection.
    `Collection<ErlangValue>` | ErlangValue.`listCollectionValue(Class<? extends Collection<ErlangValue>> clazz)` Returns a `Collection` of mixed Java values (wrapped in `ErlangValue` objects) of the wrapped erlang value (internally represented as a list in Erlang).
    `ScalarisVM.DeleteNodesByNameResult` | ScalarisVM.`shutdownNodesByName(List<ErlangValue> names)` Shuts down the given nodes (graceful leave) inside the Scalaris VM of the current connection.

    Constructors in de.zib.scalaris with parameters of type ErlangValue
    Constructor and Description
    `KeyChangedException(ErlangValue old_value)` Creates the exception with the given old value.
    `KeyChangedException(Throwable e, ErlangValue old_value)` Creates the exception with the given old value taking the message of the given throwable.

  - ### Uses of ErlangValue in de.zib.scalaris.examples

    Subclasses of ErlangValue in de.zib.scalaris.examples
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ErlangValueBitString` Implements a faster `String` storage mechanism using erlang bitstrings.
    `class` | `ErlangValueFastString` Implements a faster `String` storage mechanism if only Java access to scalaris is used.

    Constructors in de.zib.scalaris.examples with parameters of type ErlangValue
    Constructor and Description
    `ErlangValueBitString(ErlangValue value)` Creates an object with the given (erlang) value.
    `ErlangValueFastString(ErlangValue value)` Creates an object with the given (erlang) value.

  - ### Uses of ErlangValue in de.zib.scalaris.executor

    Methods in de.zib.scalaris.executor that return ErlangValue
    Modifier and Type | Method and Description
    --- | ---
    `ErlangValue` | ScalarisReadOp.`getValue()` Gets the value from the read.

  - ### Uses of ErlangValue in de.zib.scalaris.operations

    Fields in de.zib.scalaris.operations declared as ErlangValue
    Modifier and Type | Field and Description
    --- | ---
    `ErlangValue` | ReadRandomFromListOp.Result.`randomElement` A random value from the stored list.
    `ErlangValue` | ReadSublistOp.Result.`subList` The retrieved sublist.

    Methods in de.zib.scalaris.operations that return ErlangValue
    Modifier and Type | Method and Description
    --- | ---
    `ErlangValue` | ReadOp.`processResult()`
    `ErlangValue` | ReadOp.`processResultSingle()`