LinkedBlockingDeque remainingCapacity() method in Java

The remainingCapacity() method of LinkedBlockingDeque returns the number of additional elements that this deque can ideally (in the absence of memory or resource constraints) accept without blocking.

remainingCapacity() = final_size() – current_size()

Syntax:

public int remainingCapacity()

Parameters: This method does not accepts any parameters.

Returns: This method returns the remaining number of elements that can be inserted into the deque container.

Below programs illustrate remainingCapacity() method of LinkedBlockingDeque:

Program 1:

// Java Program Demonstrate remainingCapacity()
// method of LinkedBlockingDeque
// when initial size is mentioned

import java.util.concurrent.LinkedBlockingDeque;
import java.util.*;

public class GFG {
    public static void main(String[] args)
        throws InterruptedException
    {

        // create object of LinkedBlockingDeque
        LinkedBlockingDeque<Integer> LBD
            = new LinkedBlockingDeque<Integer>(6);

        // Add numbers to end of LinkedBlockingDeque
        LBD.add(7855642);
        LBD.add(35658786);
        LBD.add(5278367);
        LBD.add(74381793);

        // print Dequeue
        System.out.println("Linked Blocking Deque: " + LBD);
        System.out.println("remainingCapacity = : " +
                              LBD.remainingCapacity());
    }
}

Output:

Linked Blocking Deque: [7855642, 35658786, 5278367, 74381793]
remainingCapacity = : 2

Program 2:

// Java Program Demonstrate remainingCapacity()
// method of LinkedBlockingDeque
// when no initial size is mentioned

import java.util.concurrent.LinkedBlockingDeque;
import java.util.*;

public class GFG {
    public static void main(String[] args)
        throws InterruptedException
    {

        // create object of LinkedBlockingDeque
        LinkedBlockingDeque<Integer> LBD
            = new LinkedBlockingDeque<Integer>(6);

        // Add numbers to end of LinkedBlockingDeque
        LBD.add(7855642);
        LBD.add(35658786);
        LBD.add(5278367);
        LBD.add(74381793);

        // print Dequeue
        System.out.println("Linked Blocking Deque: " + LBD);
        System.out.println("remainingCapacity = " +
                             LBD.remainingCapacity());
    }
}

Output:

Linked Blocking Deque: [7855642, 35658786, 5278367, 74381793]
remainingCapacity = 2

Reference: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/LinkedBlockingDeque.html#remainingCapacity–