akasha.core

Class JsSet<T>

java.lang.Object

akasha.core.JsSet<T>

All Implemented Interfaces:

JsIterable<T>

@JsType(name="Set",
        isNative=true,
        namespace="<global>")
public class JsSet<T>
extends java.lang.Object
implements JsIterable<T>

The Set object lets you store unique values of any type, whether primitive values or object references.

See Also:

Set - MDN, Set Objects - ECMA

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JsSet.ForEachCallback<T>
static interface	JsSet.ForEachCallback2<T>
static interface	JsSet.ForEachCallback3<T>

Constructor Summary

Constructors

Constructor and Description
JsSet() The Set constructor lets you create Set objects that store unique values of any type, whether primitive values or object references.
JsSet(JsIterable<T> values) The Set constructor lets you create Set objects that store unique values of any type, whether primitive values or object references.
JsSet(T[] values) The Set constructor lets you create Set objects that store unique values of any type, whether primitive values or object references.

Method Summary

Modifier and Type	Method and Description
JsSet<T>	add(T value) The add() method appends a new element with a specified value to the end of a Set object.
void	clear() The clear() method removes all elements from a Set object.
boolean	delete(T value) The delete() method removes a specified value from a Set object, if it is in the set.
JsIteratorIterable<JsArray<T>>	entries() The entries() method returns a new Iterator object that contains an array of [value, value] for each element in the Set object, in insertion order.
void	forEach(JsSet.ForEachCallback<T> forEachCallback) The forEach() method executes a provided function once for each value in the Set object, in insertion order.
void	forEach(JsSet.ForEachCallback2<T> forEachCallback) The forEach() method executes a provided function once for each value in the Set object, in insertion order.
void	forEach(JsSet.ForEachCallback3<T> forEachCallback) The forEach() method executes a provided function once for each value in the Set object, in insertion order.
boolean	has(T value) The has() method returns a boolean indicating whether an element with the specified value exists in a Set object or not.
JsIteratorIterable<T>	keys() The keys() method returns a new iterator object that contains the values for each element in the Set object in insertion order.
int	size() The size accessor property returns the number of (unique) elements in a Set object.
JsIteratorIterable<T>	values() The values() method returns a new iterator object that contains the values for each element in the Set object in insertion order.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akasha.lang.JsIterable

iterator

Constructor Detail

JsSet

public JsSet()

The Set constructor lets you create Set objects that store unique values of any type, whether primitive values or object references.

See Also:

Set Constructor - MDN, Set Constructor - ECMA

JsSet

public JsSet(@Nonnull
             JsIterable<T> values)

The Set constructor lets you create Set objects that store unique values of any type, whether primitive values or object references.

Parameters:

values - the iterable that will have all of it's elements added to the Set.

See Also:

Set Constructor - MDN, Set Constructor - ECMA

JsSet

public JsSet(@Nonnull
             T[] values)

The Set constructor lets you create Set objects that store unique values of any type, whether primitive values or object references.

Parameters:

values - the array that will have all of it's elements added to the Set.

See Also:

Set Constructor - MDN, Set Constructor - ECMA

Method Detail

size

@JsProperty(name="size")
public int size()

The size accessor property returns the number of (unique) elements in a Set object.

Returns:

an integer representing how many entries the Set object has.

See Also:

Set.prototype.size - MDN, Set.prototype.size - ECMA

add

@Nonnull
public JsSet<T> add(@Nullable
                             T value)

The add() method appends a new element with a specified value to the end of a Set object.

Parameters:

value - the value of the element to add to the Set object.

Returns:

the set.

See Also:

Set.prototype.add - MDN, Set.prototype.add - ECMA

clear

public void clear()

The clear() method removes all elements from a Set object.

See Also:

Set.prototype.clear - MDN, Set.prototype.clear - ECMA

delete

public boolean delete(@Nullable
                      T value)

The delete() method removes a specified value from a Set object, if it is in the set.

Parameters:

value - the value to remove from the set object.

Returns:

true if value was already in the set, otherwise false.

See Also:

Set.prototype.delete - MDN, Set.prototype.delete - ECMA

forEach

public void forEach(@Nonnull
                    JsSet.ForEachCallback<T> forEachCallback)

The forEach() method executes a provided function once for each value in the Set object, in insertion order.

Parameters:

forEachCallback - the function to execute for each element.

See Also:

Set.prototype.forEach - MDN, Set.prototype.forEach - ECMA

forEach

public void forEach(@Nonnull
                    JsSet.ForEachCallback2<T> forEachCallback)

The forEach() method executes a provided function once for each value in the Set object, in insertion order.

Parameters:

forEachCallback - the function to execute for each element.

See Also:

Set.prototype.forEach - MDN, Set.prototype.forEach - ECMA

forEach

public void forEach(@Nonnull
                    JsSet.ForEachCallback3<T> forEachCallback)

The forEach() method executes a provided function once for each value in the Set object, in insertion order.

Parameters:

forEachCallback - the function to execute for each element.

See Also:

Set.prototype.forEach - MDN, Set.prototype.forEach - ECMA

has

public boolean has(@Nullable
                   T value)

The has() method returns a boolean indicating whether an element with the specified value exists in a Set object or not.

Returns:

the value to test for presence in the Set object.

See Also:

Set.prototype.has - MDN, Set.prototype.has - ECMA

entries

@Nonnull
public JsIteratorIterable<JsArray<T>> entries()

The entries() method returns a new Iterator object that contains an array of [value, value] for each element in the Set object, in insertion order.

Returns:

a new iterator object that contains an array of [value, value] for each element in the given Set, in insertion order.

See Also:

Set.prototype.entries - MDN, Set.prototype.entries - ECMA

keys

@Nonnull
public JsIteratorIterable<T> keys()

The keys() method returns a new iterator object that contains the values for each element in the Set object in insertion order.

Returns:

a new iterator object containing the values for each element in the given Set, in insertion order.

See Also:

Set.prototype.keys - MDN, Set.prototype.keys - ECMA

values

@Nonnull
public JsIteratorIterable<T> values()

The values() method returns a new iterator object that contains the values for each element in the Set object in insertion order.

Returns:

a new iterator object containing the values for each element in the given Set, in insertion order.

See Also:

Set.prototype.values - MDN, Set.prototype.values - ECMA