InsertionOrderSet (jaulp.collections 3.9.0 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractSet<E>
  - - java.util.HashSet<E>
    - - java.util.LinkedHashSet<E>
      - net.sourceforge.jaulp.collections.InsertionOrderSet<E>

Type Parameters:
E - the type of elements maintained by this set

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, Set<E>
```
public class InsertionOrderSet<E>
extends LinkedHashSet<E>
```
This class overwrites the put-method from the LinkedHashSet. That inserts the value to the right order it was inserted in the Map. Note that the difference in the LinkedHashMap is the order does not change if we put the same key with a new value. In this class the order changes when we put a new value with the same key.

Version:

1.0

Author:

Asterios Raptis

See Also:
LinkedHashSet, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`InsertionOrderSet()` Constructs an empty insertion-ordered `InsertionOrderSet` instance with a default capacity (16) and load factor (0.75).
`InsertionOrderSet(Collection<? extends E> c)` Constructs a new insertion order hash set with the same elements as the specified collection.
`InsertionOrderSet(int initialCapacity)` Constructs an empty insertion-ordered `InsertionOrderSet` instance with the specified initial capacity and a default load factor (0.75).
`InsertionOrderSet(int initialCapacity, float loadFactor)` Constructs an empty insertion-ordered `InsertionOrderMap` instance with the specified initial capacity and load factor.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(E o)` Adds the specified object to this set.
`static <E> Set<E>`	`setOf(E... elements)` Factory method for create an InsertionOrderSet with the given elements.

Methods inherited from class java.util.HashSet
clear, clone, contains, isEmpty, iterator, remove, size

Methods inherited from class java.util.AbstractSet
equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection
addAll, containsAll, retainAll, toArray, toArray, toString

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

Methods inherited from interface java.util.Set
addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

- Constructor Detail
  - InsertionOrderSet
```
public InsertionOrderSet()
```
    Constructs an empty insertion-ordered InsertionOrderSet instance with a default capacity (16) and load factor (0.75).
  - InsertionOrderSet
```
public InsertionOrderSet(Collection<? extends E> c)
```
    Constructs a new insertion order hash set with the same elements as the specified collection. The insertion order hash set is created with an initial capacity sufficient to hold the elements in the specified collection and the default load factor (0.75).
    
    Parameters:
    c - the collection whose elements are to be placed into this set.
    
    Throws:
    
    NullPointerException - if the specified collection is null.
  - InsertionOrderSet
```
public InsertionOrderSet(int initialCapacity)
```
    Constructs an empty insertion-ordered InsertionOrderSet instance with the specified initial capacity and a default load factor (0.75).
    
    Parameters:
    initialCapacity - the initial capacity.
    
    Throws:
    
    IllegalArgumentException - if the initial capacity is negative.
  - InsertionOrderSet
```
public InsertionOrderSet(int initialCapacity,
                 float loadFactor)
```
    Constructs an empty insertion-ordered InsertionOrderMap instance with the specified initial capacity and load factor.
    
    Parameters:
    initialCapacity - the initial capacity.
    loadFactor - the load factor.
    
    Throws:
    
    IllegalArgumentException - if the initial capacity is negative or the load factor is nonpositive.
- Method Detail
  - add
```
public boolean add(E o)
```
    Adds the specified object to this set. If the set previously contained a the same object, the old object is removed and then insert again. That inserts the object to the right order it was inserted in the Set. Note that the difference in the LinkedHashSet is the order does not change if we try to add the same object. In this class the order changes when we add a object that allready exists.
    
    Specified by:
    
    add in interface Collection<E>
    
    Specified by:
    
    add in interface Set<E>
    
    Overrides:
    
    add in class HashSet<E>
    
    Parameters:
    o - The object to add.
    
    Returns:
    true if the set did not already contain the specified element.
  - setOf
```
public static <E> Set<E> setOf(E... elements)
```
    Factory method for create an InsertionOrderSet with the given elements.
    
    Parameters:
    elements - The given elements.
    
    Returns:
    a new InsertionOrderSet that contains the given elements.

Class InsertionOrderSet<E>

Constructor Summary

Method Summary

Methods inherited from class java.util.HashSet

Methods inherited from class java.util.AbstractSet

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Constructor Detail

InsertionOrderSet

InsertionOrderSet

InsertionOrderSet

InsertionOrderSet

Method Detail

add

setOf