Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Berkeley DB Java Edition version 3.1.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sleepycat.persist.evolve
Class Mutations

    java.lang.Object
      com.sleepycat.persist.evolve.Mutations

All Implemented Interfaces:
  Serializable

    public class Mutations

extends Object
implements Serializable

A collection of mutations for configuring class evolution.

Mutations are configured when a store is opened via `StoreConfig.setMutations`. For example:

      Mutations mutations = new Mutations();
      // Add mutations...
      StoreConfig config = new StoreConfig();
      config.setMutations(mutations);
      EntityStore store = new EntityStore(env, "myStore", config);

Mutations cause data conversion to occur lazily as instances are read from the store. The `EntityStore.evolve` method may also be used to perform eager conversion.

Not all incompatible class changes can be handled via mutations. For example, complex refactoring may require a transformation that manipulates multiple entity instances at once. Such changes are not possible with mutations but can made by performing a store conversion.

Author:
  Mark Hayes
See Also:
  `Class Evolution`, Serialized Form

Constructor Summary
`Mutations()` Creates an empty set of mutations.

Method Summary
`void` | `addConverter(Converter converter)` Adds a converter mutation.
`void` | `addDeleter(Deleter deleter)` Adds a deleter mutation.
`void` | `addRenamer(Renamer renamer)` Adds a renamer mutation.
`boolean` | `equals(Object other)` Returns true if this collection has the same set of mutations as the given collection and all mutations are equal.
`Converter` | `getConverter(String className, int classVersion, String fieldName)` Returns the converter mutation for the given class, version and field, or null if none exists.
`Collection<Converter>` | `getConverters()` Returns an unmodifiable collection of all converter mutations.
`Deleter` | `getDeleter(String className, int classVersion, String fieldName)` Returns the deleter mutation for the given class, version and field, or null if none exists.
`Collection<Deleter>` | `getDeleters()` Returns an unmodifiable collection of all deleter mutations.
`Renamer` | `getRenamer(String className, int classVersion, String fieldName)` Returns the renamer mutation for the given class, version and field, or null if none exists.
`Collection<Renamer>` | `getRenamers()` Returns an unmodifiable collection of all renamer mutations.
`boolean` | `isEmpty()` Returns true if no mutations are present.
`String` | `toString()`

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

Constructor Detail

### Mutations

    public Mutations()

  Creates an empty set of mutations.

Method Detail

### isEmpty

    public boolean isEmpty()

  Returns true if no mutations are present.

### addRenamer

    public void addRenamer(Renamer renamer)

  Adds a renamer mutation.

### getRenamer

    public Renamer getRenamer(String className,
                              int classVersion,
                              String fieldName)

  Returns the renamer mutation for the given class, version and field, or null if none exists. A null field name should be specified to get a class renamer.

### getRenamers

    public Collection<Renamer> getRenamers()

  Returns an unmodifiable collection of all renamer mutations.

### addDeleter

    public void addDeleter(Deleter deleter)

  Adds a deleter mutation.

### getDeleter

    public Deleter getDeleter(String className,
                              int classVersion,
                              String fieldName)

  Returns the deleter mutation for the given class, version and field, or null if none exists. A null field name should be specified to get a class deleter.

### getDeleters

    public Collection<Deleter> getDeleters()

  Returns an unmodifiable collection of all deleter mutations.

### addConverter

    public void addConverter(Converter converter)

  Adds a converter mutation.

### getConverter

    public Converter getConverter(String className,
                                  int classVersion,
                                  String fieldName)

  Returns the converter mutation for the given class, version and field, or null if none exists. A null field name should be specified to get a class converter.

### getConverters

    public Collection<Converter> getConverters()

  Returns an unmodifiable collection of all converter mutations.

### equals

    public boolean equals(Object other)

  Returns true if this collection has the same set of mutations as the given collection and all mutations are equal.

  Overrides:
    `equals` in class `Object`

### toString

    public String toString()

  Overrides:
    `toString` in class `Object`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Berkeley DB Java Edition version 3.1.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright(c) 1996-2006 Oracle Corporation - All rights reserved.