Java LinkedBlockingDeque drainTo() Method

The drainTo() method of LinkedBlockingDeque() class removes all the elements present in this queue and adds them to the provided collection.

Syntax:

public int drainTo(Collection<? super E> c)
public int drainTo(Collection<? super E> c, int maxElements)

Parameters:

c - this is the collection to which elements are transferred.

maxElements - this is the maximum number of elements to be transferred.

Specified By:

The drainTo() method of LinkedBlockingDeque class is specified by drainTo() method in interface BlockingQueue<E>.

Return Value:

The drainTo() method returns the number of elements that are transferred.

Throws:

The drainTo() method throws:

UnsupportedOperationException - if the specified collection doesn't supports the addition of elements.

ClassCastException - if the class of an element in this queue stops it from being added to the defined collection.

NullPointerException - if the defined collection is null.

IllegalArgumentException - if the defined collection is this queue.

Example 1

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.LinkedBlockingDeque;
public class LinkedBlockingDequeDrainToExample1 {
    public static void main(String[] args) {
        List<Integer> list = new ArrayList<Integer>();
        int capacity = 100;
        LinkedBlockingDeque<Integer> deque = new LinkedBlockingDeque<Integer>(capacity);
        deque.add(0);
        deque.add(1);
        deque.add(2);
        System.out.println("Elements int the queue = "+deque);
        //drainTo() method removes all available elements from this queue and adds them to the list
        deque.drainTo(list);
        System.out.println("Elements left in the queue :"+deque);
        System.out.println("Elements drained in the list"+list);
    }
}

Test it Now

Output:

Elements int the queue = [0, 1, 2]
Elements left in the queue :[]
Elements drained in the list[0, 1, 2]

Example 2

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.LinkedBlockingDeque;
public class LinkedBlockingDequeDrainToExample2 {
    public static void main(String[] args) {
        List<Integer> list = new ArrayList<Integer>();
        int capacity = 100;
        LinkedBlockingDeque<Integer> deque = new LinkedBlockingDeque<Integer>(capacity);
        for (int i=0;i<11;i++) {
            deque.add(i);
        }
        System.out.println("Elements int the queue = "+deque);
       /*drainTo() method removes at most the given number of available elements
          from this queue and adds them to the list.*/
        deque.drainTo(list,5);
        System.out.println("Elements left in the queue :"+deque);
        System.out.println("Elements drained in the list"+list);
    }
}

Test it Now

Output:

Elements int the queue = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
Elements left in the queue :[5, 6, 7, 8, 9, 10]
Elements drained in the list[0, 1, 2, 3, 4]

Example 3

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.LinkedBlockingDeque;
public class LinkedBlockingDequeDrainToExample3 {
    public static void main(String[] args) {
        List<String> list = new ArrayList<String>();
        int capacity = 100;
        LinkedBlockingDeque<String> deque = new LinkedBlockingDeque<String>(capacity);
        deque.add("Ram");
        deque.add("Sham");
        deque.add("Sunita");
        System.out.println("Elements int the queue = "+deque);
        //drainTo() method removes all available elements from this queue and adds them to the list
        deque.drainTo(list,2);
        System.out.println("Elements left in the queue :"+deque);
        System.out.println("Elements drained in the list"+list);
    }
}

Test it Now

Output:

Elements int the queue = [Ram, Sham, Sunita]
Elements left in the queue :[Sunita]
Elements drained in the list[Ram, Sham]

Next TopicJava Linkedblockingdeque

← prev next →

Latest Courses

We provides tutorials and interview questions of all technology like java tutorial, android, java frameworks

Contact info

G-13, 2nd Floor, Sec-3, Noida, UP, 201301, India

[email protected].

Python

AI, ML and Data Science

Java

B.Tech and MCA

Web Technology

Software Testing

Technical Interview

Java Interview

Web Interview

Database Interview

Company Interviews

Java Tutorial

Control Statements

Java Object Class

Java Inheritance

Java Polymorphism

Java Abstraction

Java Encapsulation

Java Array

Java OOPs Misc

Java String

Java String Methods

Java Regex

Exception Handling

Java Inner Class

Java Multithreading

Java Synchronization

Java Networking

Java Applet

Java Reflection

Java Conversion

Java JDBC

RMI

Internationalization

Java Array Class

Java AtomicInteger Class

Java AtomicLong Methods

Java Authenticator

Java BigDecimal class

Big Integer Class

Java Boolean class

Java Byte Class

Java Class

Java Collections class

Java Compiler Class

CopyOnWriteArrayList

Java Math Methods

LinkedBlockingDeque

Java Long class

LinkedTransferQueue

Java List

Java MulticastSocket

Java Number Class

Java Phaser Class

ArrayList Methods

Java Thread Methods

Java Projects

Java Programs

Java Misc

Java Date Class

Java ListIterator Class

Java NIO Tutorial

HttpURLConnection

Java Deque

Java HttpCookie Class

Java URL class

Java List Methods

Java Vector class

Java Collection Methods

Java Socket Class

Java Executors

Java LinkedBlockingDeque drainTo() Method

Syntax:

Parameters:

Specified By:

Return Value:

Throws:

Example 1

Example 2

Example 3