StealPool (constellation 2.0.0 API)

java.lang.Object
- ibis.constellation.StealPool

All Implemented Interfaces:

java.io.Serializable
```
public final class StealPool
extends java.lang.Object
implements java.io.Serializable
```
A StealPool is one of the mechanisms to determine the activities that are to be executed by an Executor. Each executor has two steal pools associated with it: the one it belongs to and the one it can steal from. In addition, an executor can only execute activities whose AbstractContext matches with the AbstractContext of this executor. A StealPool consists of either a set of other steal pools, or a single string identification.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static StealPool`	`NONE` An executor that belongs to the `NONE` steal pool generates activities that cannot be stolen.
`static StealPool`	`WORLD` An executor that belongs to the `WORLD` steal pool generates activities that can in principle be stolen by any other executor.

Constructor Summary

Constructors
Constructor and Description

StealPool(java.lang.String tag)
Constructs a StealPool of the specified tag.

Constructors
Constructor and Description
`StealPool(java.lang.String tag)` Constructs a StealPool of the specified tag.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getTag()` Returns the tag of this steal pool.
`int`	`hashCode()`
`boolean`	`isNone()` Determines if this steal pool is equal to the `NONE` steal pool.
`boolean`	`isWorld()` Determines if this steal pool is equal to the `WORLD` steal pool.
`static StealPool`	`merge(StealPool... pools)` Returns a StealPool that is the merge result of the steal pools passed as arguments.
`boolean`	`overlap(StealPool other)` Determines if this steal pool has some member steal pool in common with the specified steal pool.
`StealPool`	`randomlySelectPool(java.util.Random random)` Selects a random member steal pool from the steal pool at hand.
`StealPool[]`	`set()` Returns the list of steal pools of which this steal pool consists.
`java.lang.String`	`toString()`

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

- Field Detail
  - WORLD
```
public static StealPool WORLD
```
    An executor that belongs to the WORLD steal pool generates activities that can in principle be stolen by any other executor. An executor that can steal from this steal pool can steal from any pool, except NONE.
  - NONE
```
public static StealPool NONE
```
    An executor that belongs to the NONE steal pool generates activities that cannot be stolen. An executor that can steal from this steal pool can in fact not steal at all. Note that NONE takes preference over WORLD.
- Constructor Detail
  - StealPool
```
public StealPool(java.lang.String tag)
```
    Constructs a StealPool of the specified tag.
    
    Parameters:
    
    tag - the tag
    
    Throws:
    
    java.lang.IllegalArgumentException - when a null pointer is provided.
- Method Detail
  - merge
```
public static StealPool merge(StealPool... pools)
```
    Returns a StealPool that is the merge result of the steal pools passed as arguments. If the argument list is empty, NONE is returned. If the argument list contains WORLD, WORLD is returned.
    
    Parameters:
    
    pools - the steal pool arguments
    
    Returns:
    
    the merge result
    
    Throws:
    
    java.lang.IllegalArgumentException - when the argument list contains a null pointer.
  - overlap
```
public boolean overlap(StealPool other)
```
    Determines if this steal pool has some member steal pool in common with the specified steal pool. NONE never overlaps, not even with NONE. And then WORLD overlaps with any steal pool, except NONE.
    
    Parameters:
    
    other - the steal pool to determine overlap with.
    
    Returns:
    
    whether there is overlap between the steal pools.
  - getTag
```
public java.lang.String getTag()
```
    Returns the tag of this steal pool. It this steal pool in fact consists of other steal pools, null is returned.
    
    Returns:
    
    the tag of this steal pool.
  - isWorld
```
public boolean isWorld()
```
    Determines if this steal pool is equal to the WORLD steal pool.
    
    Returns:
    
    if this steal pool is the WORLD steal pool.
  - isNone
```
public boolean isNone()
```
    Determines if this steal pool is equal to the NONE steal pool.
    
    Returns:
    
    if this steal pool is the NONE steal pool.
  - set
```
public StealPool[] set()
```
    Returns the list of steal pools of which this steal pool consists. If this steal pool has no members, a list with only this steal pools is returned.
    
    Returns:
    
    the member steal pools.
  - randomlySelectPool
```
public StealPool randomlySelectPool(java.util.Random random)
```
    Selects a random member steal pool from the steal pool at hand.
    
    Parameters:
    
    random - the random number generator to use
    
    Returns:
    
    a random member steal pool.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class StealPool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WORLD

NONE

Constructor Detail

StealPool

Method Detail

merge

overlap

getTag

isWorld

isNone

set

randomlySelectPool

toString

hashCode

equals