DSet (Narya Core 1.15 API)

java.lang.Object
- com.threerings.presents.dobj.DSet<E>

Type Parameters:

E - the type of entry stored in this set.

All Implemented Interfaces:

Streamable, Cloneable, Iterable<E>
```
public class DSet<E extends DSet.Entry>
extends Object
implements Iterable<E>, Streamable, Cloneable
```
The distributed set class provides a means by which an unordered set of objects can be maintained as a distributed object field. Entries can be added to and removed from the set, requests for which will generate events much like other distributed object fields.
Classes that wish to act as set entries must implement the DSet.Entry interface which extends Streamable and adds the requirement that the object provide a key which will be used to identify entry equality. Thus an entry is declared to be in a set of the object returned by that entry's DSet.Entry.getKey() method is equal (using Object.equals(java.lang.Object)) to the entry returned by the DSet.Entry.getKey() method of some other entry in the set. Additionally, in the case of entry removal, only the key for the entry to be removed will be transmitted with the removal event to save network bandwidth. Lastly, the object returned by DSet.Entry.getKey() must be a Streamable type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DSet.Entry
Entries of the set must implement this interface.
- Nested classes/interfaces inherited from interface com.threerings.io.Streamable
  Streamable.Closure

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DSet.Entry` Entries of the set must implement this interface.

Constructor Summary

Constructors
Constructor and Description
`DSet()` Constructs an empty distributed set.
`DSet(E[] source)` Creates a distributed set and populates it with values from the supplied array.
`DSet(Iterable<? extends E> source)` Creates a distributed set and populates it with values from the supplied iterator.
`DSet(Iterator<? extends E> source)` Creates a distributed set and populates it with values from the supplied iterator.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Set<E>`	`asSet()` Creates an immutable view of this distributed set as a Java set.
`DSet<E>`	`clone()` Generates a shallow copy of this object.
`static int`	`compare(Comparable<?> c1, Comparable<?> c2)` Compares the first comparable to the second.
`boolean`	`contains(E elem)` Returns true if the set contains an entry whose `getKey()` method returns a key that `equals()` the key returned by `getKey()` of the supplied entry.
`boolean`	`containsKey(Comparable<?> key)` Returns true if an entry in the set has a key that `equals()` the supplied key.
`Iterator<E>`	`entries()` Deprecated.
`E`	`get(Comparable<?> key)` Returns the entry that matches (`getKey().equals(key)`) the specified key or null if no entry could be found that matches the key.
`boolean`	`isEmpty()` Returns `true` if this set contains no entries.
`Iterator<E>`	`iterator()` Returns an iterator over the entries of this set.
`static <E extends DSet.Entry> DSet<E>`	`newDSet()` Creates a new DSet of the appropriate generic type.
`static <E extends DSet.Entry> DSet<E>`	`newDSet(Iterable<? extends E> source)` Creates a new DSet of the appropriate generic type.
`void`	`readObject(ObjectInputStream in)` Custom reader method.
`int`	`size()` Returns the number of entries in this set.
`E[]`	`toArray(E[] array)` Deprecated. use `clone()` or `toArrayList()`.
`Object[]`	`toArray(Object[] array)` Deprecated. use `clone()` or `toArrayList()`.
`ArrayList<E>`	`toArrayList()` Copies the elements of this distributed set into a newly created `ArrayList`.
`String`	`toString()`
`DSet<E>`	`typedClone()` Deprecated. clone() works just fine now.
`void`	`writeObject(ObjectOutputStream out)` Custom writer method.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - DSet
```
public DSet(Iterable<? extends E> source)
```
    Creates a distributed set and populates it with values from the supplied iterator. This should be done before the set is unleashed into the wild distributed object world because no associated entry added events will be generated. Additionally, this operation does not check for duplicates when adding entries, so one should be sure that the iterator contains only unique entries.
    
    Parameters:
    
    source - an iterator from which we will initially populate the set.
  - DSet
```
public DSet(Iterator<? extends E> source)
```
    Creates a distributed set and populates it with values from the supplied iterator. This should be done before the set is unleashed into the wild distributed object world because no associated entry added events will be generated. Additionally, this operation does not check for duplicates when adding entries, so one should be sure that the iterator contains only unique entries.
    
    Parameters:
    
    source - an iterator from which we will initially populate the set.
  - DSet
```
public DSet(E[] source)
```
    Creates a distributed set and populates it with values from the supplied array. This should be done before the set is unleashed into the wild distributed object world because no associated entry added events will be generated. Additionally, this operation does not check for duplicates when adding entries, so one should be sure that the iterator contains only unique entries.
    
    Parameters:
    
    source - an array from which we will initially populate the set.
  - DSet
```
public DSet()
```
    Constructs an empty distributed set.
- Method Detail
  - newDSet
```
public static <E extends DSet.Entry> DSet<E> newDSet()
```
    Creates a new DSet of the appropriate generic type.
  - newDSet
```
public static <E extends DSet.Entry> DSet<E> newDSet(Iterable<? extends E> source)
```
    Creates a new DSet of the appropriate generic type.
  - compare
```
public static int compare(Comparable<?> c1,
                          Comparable<?> c2)
```
    Compares the first comparable to the second. This is useful to avoid type safety warnings when dealing with the keys of DSet.Entry values.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this set contains no entries.
  - size
```
public int size()
```
    Returns the number of entries in this set.
  - contains
```
public boolean contains(E elem)
```
    Returns true if the set contains an entry whose getKey() method returns a key that equals() the key returned by getKey() of the supplied entry. Returns false otherwise.
  - containsKey
```
public boolean containsKey(Comparable<?> key)
```
    Returns true if an entry in the set has a key that equals() the supplied key. Returns false otherwise.
  - get
```
public E get(Comparable<?> key)
```
    Returns the entry that matches (getKey().equals(key)) the specified key or null if no entry could be found that matches the key.
  - entries
```
@Deprecated
public Iterator<E> entries()
```
    Deprecated.
    
    Returns an iterator over the entries of this set. It does not support modification (nor iteration while modifications are being made to the set). It should not be kept around as it can quickly become out of date.
  - iterator
```
public Iterator<E> iterator()
```
    Returns an iterator over the entries of this set. It does not support modification (nor iteration while modifications are being made to the set). It should not be kept around as it can quickly become out of date.
    
    Specified by:
    
    iterator in interface Iterable<E extends DSet.Entry>
  - asSet
```
public Set<E> asSet()
```
    Creates an immutable view of this distributed set as a Java set.
  - toArrayList
```
public ArrayList<E> toArrayList()
```
    Copies the elements of this distributed set into a newly created ArrayList.
  - toArray
```
@Deprecated
public E[] toArray(E[] array)
```
    Deprecated. use clone() or toArrayList().
  - toArray
```
@Deprecated
public Object[] toArray(Object[] array)
```
    Deprecated. use clone() or toArrayList().
  - typedClone
```
@Deprecated
public DSet<E> typedClone()
```
    Deprecated. clone() works just fine now.
    
    Generates a shallow copy of this object in a type safe manner.
  - clone
```
public DSet<E> clone()
```
    Generates a shallow copy of this object.
    
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - writeObject
```
public void writeObject(ObjectOutputStream out)
                 throws IOException
```
    Custom writer method. @see Streamable.
    
    Throws:
    
    IOException
  - readObject
```
public void readObject(ObjectInputStream in)
                throws IOException,
                       ClassNotFoundException
```
    Custom reader method. @see Streamable.
    
    Throws:
    
    IOException
    
    ClassNotFoundException

Class DSet<E extends DSet.Entry>

Nested Class Summary

Nested classes/interfaces inherited from interface com.threerings.io.Streamable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

DSet

DSet

DSet

DSet

Method Detail

newDSet

newDSet

compare

isEmpty

size

contains

containsKey

get

entries

iterator

asSet

toArrayList

toArray

toArray

typedClone

clone

toString

writeObject

readObject