Creates a new set object. If the type argument is defined, the set is considered as typed, and then the type of all elements inserted in this set is checked.

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element, o, to this set if this set contains no element e such that o === e. If this set already contains the specified element, the call leaves this set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throwing an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the the elements that they may contain.

   var set : Set = new Set( String );
   
   set.add( "foo" );
   
   set.add( "foo" ); // return false, as 'foo' already exist in this set
   
   set.add( 25 ); // throw a ClassCastException, as 25 is not a string 
   

   var set : Set = new Set( Object );
   var o : Object = { x : 50, y : 100 };
   
   set.add( o ); 
   set.add( o ); // return false, as o' already exist in this set
   
   set.add( { x : 50, y : 100 } ); // return true, as the argument is not
              // the same object than o, even if all
              // their properties are equals
   

Adds all of the elements in the specified Collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress.

The rules which govern collaboration between typed and untyped Collection are described in the isValidCollection descrition, all rules described there are supported by the addAll method.

See also

Let say that you have two typed sets typedSet1 and typedSet1.

   var typedSet1 : Set = new Set( String );
   var typedSet2 : Set = new Set( String );
   
   typedSet1.add( "foo1" );
   typedSet1.add( "foo2" );
   typedSet1.add( "foo3" );
   typedSet1.add( "foo4" );
   
   typedSet2.add( "foo3" );
   typedSet2.add( "foo4" );
   typedSet2.add( "foo5" );
   typedSet2.add( "foo6" );
   

   var untypedSet1 : Set = new Set();
   var untypedSet2 : Set = new Set();
   
   untypedSet1.add( 1 );
   untypedSet1.add( 2 );
   untypedSet1.add( 3 );
   untypedSet1.add( "foo1" );
   
   untypedSet1.add( 3 );
   untypedSet1.add( 4 );
   untypedSet1.add( 5 );
   untypedSet1.add( "foo1" );
   

   
   typedSet1.addAll ( typedSet2 );
   // will produce a set containing : 
   // 'foo1'
   // 'foo2'
   // 'foo3'
   // 'foo4'
   // 'foo5'
   // 'foo6'
   
   untypedSet1.addAll ( untypedSet2 );
   // will produce a set containing : 
   // 'foo1'
   // 1
   // 2
   // 3
   // 4
   // 5
   

   untypedSet1.addAll( typedSet2 );
   // will produce a set containing : 
   // 'foo1'
   // 'foo3'
   // 'foo4'
   // 'foo5'
   // 'foo6'
   // 1
   // 2
   // 3
   // 4
   // 5
   

   try
   {
    typedSet2.addAll( untypedSet2 );
   }
   catch( e : IllegalArgumentException )
   {
    trace( e ); 
    // The passed-in collection with type 'null' has not the same type 
    // than com.bourre.collections::Set<String>
   }
   

Inserts all of the elements in the specified Collection into this set at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the stack in the order that they are returned by the specified Collection's iterator.

The rules which govern collaboration between typed and untyped Collection are described in the isValidCollection descrition, all rules described there are supported by the containsAll method.

See also

Inserts the specified element at the specified position in this set. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

See also

Removes all of the elements from this set (optional operation). This set will be empty after this call returns (unless it throws an exception).

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that o === e.

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a Set, this method returns true if it is a subset of this set.

The rules which govern collaboration between typed and untyped Collection are described in the isValidCollection descrition, all rules described there are supported by the containsAll method.

See also

Compares the specified object with this set for equality. Returns true if the specified object is also a Set, the two sets have the same size, and every member of the specified Set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set class.

Returns the Object stored at the passed-in index in this set object.

If the passed-in index is not a valid index for this set, the function throw an IndexOutOfBoundsException exception.

Return the class type of element in this set object.

An untyped set returns null, as the wildcard type (/code>) is not a Class and Object class doesn't fit for primitive types.

Verify that the passed-in uint index is a valid index for this Set. If not, an IndexOutOfBoundsException exception is thrown.

Verify that the passed-in uint index is a valid index for an insertion in this Set. If not, an IndexOutOfBoundsException exception is thrown.

Verify that the passed-in object is valid for this Set (well-typed, not already present in the set).

In the case that the object's type prevents it to be added as element for this set the method will throw a ClassCastException.

Verify that the passed-in object type match the current Set element's type.

In the case that the set is untyped the function will always returns true.

In the case that the object's type prevents it to be added as element for this set the method will throw a ClassCastException.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Returns the index of the last occurrence of the specified object in this Set.

Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to the next method. An initial call to the previous method would return the element with the specified index minus one.

This implementation returns a straightforward implementation of the ListIterator interface that extends the implementation of the Iterator interface returned by the iterator() method. The ListIterator implementation relies on the backing list's get(int), set(int, Object), add(int, Object) and remove(int) methods.

Verify that the passed-in object type match the current set element's type.

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that o === e, if the set contains such an element. Returns true if the set contained the specified element (or equivalently, if the set changed as a result of the call). (The set will not contain the specified element once the call returns.)

   var set : Set = new Set();
   set.add ( "foo" );
   
   trace( set.size() ); // 1
   trace( set.remove( "foo" ) ); // true, the passed-in value have been removed
   
   trace( set.size() ); // 0
   trace( set.remove( "foo" ) ); // false, the passed-in value is no longer stored in this set
   

   var set : Set = new Set( String );
   set.add ( "foo" );
   
   trace( set.size() ); // 1
   trace( set.remove( "foo" ) ); // true, the passed-in value have been removed
   
   // the code below will produce an exception
   try
   {
    set.remove( 45 ); // fail, as the passed-in value is not of type string
   }
   catch( e : ClassCastException )
   {
    trace ( e );  
   }
   

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified Collection is also a Set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

The rules which govern collaboration between typed and untyped Collection are described in the isValidCollection descrition, all rules described there are supported by the removeAll method.

See also

   var set1 : Set = new Set();
   var set2 : Set = new Set();
   
   set1.add( 1 );
   set1.add( 2 );
   set1.add( 3 );
   set1.add( 4 );
   set1.add( "foo1" );
   set1.add( "foo2" );
   set1.add( "foo3" );
   set1.add( "foo4" );
   
   set2.add( 1 );
   set2.add( 3 );
   set2.add( "foo1" );
   set2.add( "foo3" );
   
   trace ( set1.removeAll ( set2 ) ) ;// true
   // set1 now contains :
   // 2, 4, 'foo2', 'foo4' 
   

Removes the element at the specified position in this set. Shifts any subsequent elements to the right (subtracts one from their indices).

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that o === e, if the set contains such an element. Returns true if the set contained the specified element (or equivalently, if the set changed as a result of the call). (The set will not contain the specified element once the call returns.)

See also

   var set : Set = new Set();
   set.add( "foo1" );
   set.add( "foo2" );
   set.add( "foo3" );
   
   trace ( set.removeAt( 2 ) ); // return true, 'foo3' have been removed
   trace ( set.removeAt( 0 ) ); // return true, 'foo1' have been removed  
           // and 'foo2' is now at index 0
   
   try
   {
    set.removeAt( 1 ); // fail, as set have only one entry at index 0
   }
   catch( e : IndexOutOfBoundsException )
   {
    trace( e );
   }
   

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a Set, this operation effectively modifies this set so that its value is the intersection of the two sets.

The rules which govern collaboration between typed and untyped Collection are described in the isValidCollection descrition, all rules described there are supported by the retainAll method.

See also

   var set1 : Set = new Set();
   var set2 : Set = new Set();
   
   set1.add( 1 );
   set1.add( 2 );
   set1.add( 3 );
   set1.add( 4 );
   set1.add( "foo1" );
   set1.add( "foo2" );
   set1.add( "foo3" );
   set1.add( "foo4" );
   
   set2.add( 1 );
   set2.add( 3 );
   set2.add( "foo1" );
   set2.add( "foo3" );
   
   trace ( set1.retainAll ( set2 ) ) ;// true
   // set1 now contains :
   // 1, 3, 'foo1', 'foo3' 
   

Insert the passed-in Object in this set at the specified index. The method returns the object previously stored at this index.

If the passed-in index is not a valid index for this set, the function throw an IndexOutOfBoundsException exception.

If the passed-in object's type prevents it to be added in this set the function will throw a ClassCastException.

Returns the number of elements in this set (its cardinality).

Returns a view of the portion of this List between fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and ToIndex are equal, the returned List is empty.)

Swap two objects stored in the passed-in index

If the passed-in index are not valid index for this set, the function throw an IndexOutOfBoundsException exception.

Returns an array containing all the elements in this set. Obeys the general contract of the Collection.toArray method.

See also

Returns the String representation of this object.

The function return a string like com.bourre.collection::Set<String> for a typed collection. The string between the < and > is the name of the type of the collection's elements. If the collection is an untyped collection the function will simply return the result of the PixlibStringifier.stringify call.