O método restanteCapacity() de BlockingQueue retorna o número de mais elementos que podem ser adicionados a BlockingQueue sem bloqueio.

A capacidade devolvida surge em três casos:

  • Se a capacidade restante for Zero, nenhum outro elemento poderá ser adicionado ao BlockingQueue.
  • Se a capacidade restante de BlockingQueue for igual ao tamanho da Fila, nenhum elemento pode ser removido da fila porque, em tal situação, a fila está vazia.
  • Em qualquer outro caso, Capacity é sempre igual a uma diferença entre a capacidade inicial deste BlockingQueue e o tamanho atual deste BlockingQueue.

Sintaxe:

public int remainingCapacity()

Valor de retorno: Este método retorna a capacidade restante do BlockingQueue.

Nota : O método restanteCapacity() de BlockingQueue foi herdado da classe Queue em Java.

Os programas abaixo ilustram o método restanteCapacity() da classe BlockingQueue:

Programa 1:

// Java Program Demonstrate remainingCapacity()
// method of BlockingQueue
  
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.BlockingQueue;
public class GFG {
  
    public static void main(String[] args)
    {
        // define capacity of BlockingQueue
        int capacityOfQueue = 7;
  
        // create object of BlockingQueue
        BlockingQueue<String> BQ
            = new LinkedBlockingQueue<String>(
                capacityOfQueue);
  
        // Add element to BlockingQueue
        BQ.add("John");
        BQ.add("Tom");
        BQ.add("Clark");
        BQ.add("Kat");
  
        // find remaining Capacity  of BQ
        // using remainingCapacity() method
        int remainingCapacity
            = BQ.remainingCapacity();
  
        // print result
        System.out.println("Queue is " + BQ);
  
        // print head of the queue
        System.out.println("Remaining Capacity of Queue is "
                           + remainingCapacity);
    }
}
Saída:
A fila é [John, Tom, Clark, Kat]
A capacidade restante da fila é 3

Programa 2:

// Java Program Demonstrate remainingCapacity()
// method of BlockingQueue
  
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.BlockingQueue;
public class GFG {
  
    public void findPeek()
    {
        // define capacity of BlockingQueue
        int capacityOfQueue = 7;
  
        // create object of BlockingQueue
        BlockingQueue<Employee> BQ
            = new LinkedBlockingQueue<Employee>(
                capacityOfQueue);
  
        // Add element to BlockingQueue
        Employee emp1
            = new Employee("Ravi", "Tester", "39000");
        Employee emp2
            = new Employee("Sanjeet", "Manager", "98000");
  
        // Add Employee Objects to BQ
        BQ.add(emp1);
        BQ.add(emp2);
  
        // add element and find remaining capacity
        // follow same process again
        // until the queue becomes full
        while (BQ.size() != 7) {
  
            // adding emp2 again and again to queue
            System.out.println(
                "Adding employee is success "
                + BQ.offer(emp2));
  
            // find remaining capacity of BQ
            // using remainingCapacity() method
            int remain = BQ.remainingCapacity();
  
            // print remaining capacity  value
            System.out.println(
                "Remaining Capacity of list :"
                + remain);
        }
    }
  
    // create an Employee Object with name,
    // position and salary as an attribute
    public class Employee {
  
        public String name;
        public String position;
        public String salary;
        Employee(String name,
                 String position,
                 String salary)
        {
            this.name = name;
            this.position = position;
            this.salary = salary;
        }
        @Override
        public String toString()
        {
            return "Employee [name=" + name
                + ", position="
                + position + ", salary="
                + salary + "]";
        }
    }
  
    // Main Method
    public static void main(String[] args)
    {
        GFG gfg = new GFG();
        gfg.findPeek();
    }
}
Saída:
Adicionar funcionário é verdadeiro sucesso
Capacidade restante da lista: 4
Adicionar funcionário é verdadeiro sucesso
Capacidade restante da lista: 3
Adicionar funcionário é verdadeiro sucesso
Capacidade restante da lista: 2
Adicionar funcionário é verdadeiro sucesso
Capacidade restante da lista: 1
Adicionar funcionário é verdadeiro sucesso
Capacidade restante da lista: 0

Referência: https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/BlockingQueue.html#remainingCapacity()