java.util.TreeSet.subSet() Method


Advertisements


Description

The subSet(E fromElement,E toElement) method is used to return a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive.

Declaration

Following is the declaration for java.util.TreeSet.subSet() method.

public SortedSet<E> subSet(E fromElement,E toElement)

Parameters

  • fromElement -- This is the low endpoint (inclusive) of the returned set.

  • toElement -- This is the high endpoint (exclusive) of the returned set.

Return Value

The method call returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive.

Exception

  • ClassCastException -- This is thrown if fromElement and toElement cannot be compared to one another using this set's comparator.

  • NullPointerException -- This is thrown if fromElement or toElement is null and this set uses natural ordering, or its comparator does not permit null elements.

  • IllegalArgumentException -- This is thrown if fromElement is greater than toElement; or if this set itself has a restricted range, and fromElement or toElement lies outside the bounds of the range.

Example

The following example shows the usage of java.util.TreeSet.subSet() method.

package com.tutorialspoint;

import java.util.TreeSet;
import java.util.Iterator;

public class TreeSetDemo {
   public static void main(String[] args) {
   // creating a TreeSet 
   TreeSet <Integer>treeadd = new TreeSet<Integer>();
   TreeSet <Integer>treesubset = new TreeSet<Integer>();
     
   // adding in the tree set
   treeadd.add(1);
   treeadd.add(2);
   treeadd.add(3);
   treeadd.add(4);
   treeadd.add(5);
   treeadd.add(6);
   treeadd.add(7);
   treeadd.add(8);
      
   // creating subset
   treesubset=(TreeSet)treeadd.subSet(3,7); 
      
   // create iterator
   Iterator iterator;
   iterator = treesubset.iterator();
     
   // displaying the Tree set data
   System.out.println("Tree subset data: ");     
   while (iterator.hasNext()){
   System.out.println(iterator.next() + " ");
   }
   }    
}

Let us compile and run the above program, this will produce the following result.

Tree subset data: 
3 
4 
5 
6

java_util_treeset.htm

Advertisements