Package net.sf.saxon.z

Class IntSet

java.lang.Object
net.sf.saxon.z.IntSet
Direct Known Subclasses:
IntArraySet, IntBlockSet, IntComplementSet, IntEmptySet, IntHashSet, IntRangeSet, IntSingletonSet, IntUniversalSet, MonotonicIntSet
public abstract class IntSet extends Object
A set of integers represented as int values

  • Constructor Summary

    Constructors
    Constructor
    Description
    IntSet()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract boolean
    add(int value)
    Add an integer to the set
    abstract void
    clear()
    Clear the contents of the IntSet (making it an empty set)
    abstract boolean
    contains(int value)
    Determine whether a particular integer is present in the set
    boolean
    containsAll(IntSet other)
    Test if this set is a superset of another set
    abstract IntSet
    copy()
    Create a copy of this IntSet that leaves the original unchanged.
    IntSet
    except(IntSet other)
    Form a new set that is the difference of this set and another set.
    IntSet
    intersect(IntSet other)
    Form a new set that is the intersection of two IntSets.
    abstract boolean
    isEmpty()
    Determine if the set is empty
    boolean
    isMutable()
    Ask whether the set permits in-situ modifications using add() and remove()
    abstract IntIterator
    iterator()
    Get an iterator over the values
    abstract IntSet
    mutableCopy()
    Create a copy of this IntSet that contains the same set of integers.
    abstract boolean
    remove(int value)
    Remove an integer from the set
    abstract int
    size()
    Get the number of integers in the set
    IntSet
    union(IntSet other)
    Form a new set that is the union of two IntSets.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • IntSet

      public IntSet()

  • Method Details

    • copy

      public abstract IntSet copy()
      Create a copy of this IntSet that leaves the original unchanged.
      Returns:
      an IntSet containing the same integers. The result will not necessarily be the same class as the original. It will either be an immutable object, or a newly constructed object.

    • mutableCopy

      public abstract IntSet mutableCopy()
      Create a copy of this IntSet that contains the same set of integers.
      Returns:
      an IntSet containing the same integers. The result will not necessarily be the same class as the original. It will always be a mutable object

    • isMutable

      public boolean isMutable()
      Ask whether the set permits in-situ modifications using add() and remove()
      Returns:
      true if the set permits in-situ modifications

    • clear

      public abstract void clear()
      Clear the contents of the IntSet (making it an empty set)

    • size

      public abstract int size()
      Get the number of integers in the set
      Returns:
      the size of the set

    • isEmpty

      public abstract boolean isEmpty()
      Determine if the set is empty
      Returns:
      true if the set is empty, false if not

    • contains

      public abstract boolean contains(int value)
      Determine whether a particular integer is present in the set
      Parameters:
      value - the integer under test
      Returns:
      true if value is present in the set, false if not

    • remove

      public abstract boolean remove(int value)
      Remove an integer from the set
      Parameters:
      value - the integer to be removed
      Returns:
      true if the integer was present in the set, false if it was not present

    • add

      public abstract boolean add(int value)
      Add an integer to the set
      Parameters:
      value - the integer to be added
      Returns:
      true if the integer was added, false if it was already present

    • iterator

      public abstract IntIterator iterator()
      Get an iterator over the values
      Returns:
      an iterator over the integers in the set

    • containsAll

      public boolean containsAll(IntSet other)
      Test if this set is a superset of another set
      Parameters:
      other - the other set
      Returns:
      true if every item in the other set is also in this set

    • union

      public IntSet union(IntSet other)
      Form a new set that is the union of two IntSets.
      Parameters:
      other - the second set
      Returns:
      the union of the two sets

    • intersect

      public IntSet intersect(IntSet other)
      Form a new set that is the intersection of two IntSets.
      Parameters:
      other - the second set
      Returns:
      the intersection of the two sets

    • except

      public IntSet except(IntSet other)
      Form a new set that is the difference of this set and another set. The result will either be an immutable object, or a newly constructed object.
      Parameters:
      other - the second set
      Returns:
      the intersection of the two sets