ides.api.plugin.model
Interface DESEventSet

All Superinterfaces:
java.util.Collection<DESEvent>, java.lang.Iterable<DESEvent>, java.util.Set<DESEvent>
All Known Subinterfaces:
SupervisoryEventSet

public interface DESEventSet
extends java.util.Set<DESEvent>

A set of DESEvents.

Author:
Lenko Grigorov

Method Summary
 DESEventSet copy()
          Produce a (deep) copy of this event set.
 DESEventSet intersect(DESEventSet set)
          Produce an event set which contains the intersection of this event set and the given event set.
 DESEventSet subtract(DESEventSet set)
          Produce an event set which contains the events in this event minus the events in the given event set.
 DESEventSet union(DESEventSet set)
          Produce an event set which contains the union of this event set and the given event set.
 
Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
 

Method Detail

copy

DESEventSet copy()
Produce a (deep) copy of this event set.

The events in the result will be copies of the original events.

Returns:
a (deep) copy of this event set

intersect

DESEventSet intersect(DESEventSet set)
Produce an event set which contains the intersection of this event set and the given event set.

The events in the intersection will be copies of the events in this event set. Thus, the method may be non-commutative in certain cases.

Parameters:
set - the event set whose content will be used for the intersection
Returns:
the intersection of this event set and the given event set

union

DESEventSet union(DESEventSet set)
Produce an event set which contains the union of this event set and the given event set.

The events in the intersection will be copies of the events in this event set and copies of all the events in the given set which are not in this set. Thus, the method may be non-commutative in certain cases.

Parameters:
set - the event set whose content will be used for the union
Returns:
the union of this event set and the given event set

subtract

DESEventSet subtract(DESEventSet set)
Produce an event set which contains the events in this event minus the events in the given event set.

The events in the result will be copies of the original events.

Parameters:
set - the event set whose content will be subtracted from this event set
Returns:
a set with the events from this set minus the events in the given set