java.util.concurrent
클래스 ArrayBlockingQueue<E>

java.lang.Object 
  java.util.AbstractCollection <E>
      java.util.AbstractQueue <E>
          java.util.concurrent.ArrayBlockingQueue<E>

형태 파라미터:

E - 컬렉션내에 존재하는 요소의 형태

모든 구현된 인터페이스:

Serializable, Iterable <E>, Collection <E>, BlockingQueue <E>, Queue <E>

public class ArrayBlockingQueue<E>
extends AbstractQueue <E>
implements BlockingQueue <E>, Serializable 

배열에 근거하는 바운드 형식블록 큐 . 이 큐는 요소를 FIFO (선입처 방편)로 정렬 합니다. 큐의 「선두」는 큐에 가장 길게 존재한 요소, 큐의 「말미」는 큐에 존재한 시간이 가장 짧은 요소가 됩니다. 새로운 요소는 큐의 말미에 삽입되어 큐 취득 조작에의해 큐의 선두 요소가 취득됩니다.

이것은 표준적인 「바운드 버퍼」이며, 그 내부에서는 고정 사이즈의 배열이 요소를 보관 유지합니다. 이러한 요소는 프로듀서에 의해 삽입되어 컨슈머(consumer)에 의해 추출됩니다. 작성 후에 용량을 늘릴 수 없습니다. 요소를 큐가 가득 될 때까지 put 하려고 하면, put 조작이 블록 됩니다. 비어있는 큐로부터 요소를 취득하려고 해도, 같은 블로킹이 발생합니다.

이 클래스는 대기중의 프로듀서 및 컨슈머(consumer) thread의 순서부를 결정하는 옵션의 균등성 정책를 지원 합니다. 디폴트에서는 이 순서부는 보증되지 않습니다. 다만, true로 설정된 균등성 정책를 사용해 구축된 큐에서는 thread가 FIFO 순서로 액세스 하는 것이 허가됩니다. 일반적으로 균등성에 의해 throughput가 저하합니다만, 변동성도 저하하기 때문에 throughput가 극단적으로 적게 될 것은 없습니다.

이 클래스와 그 반복자는 Collection 및 Iterator 인터페이스의 옵션의 메서드를 모두 구현합니다.

이 클래스는 Java Collections Framework 멤버입니다.

도입된 버전 :

1.5

관련 항목:

직렬화 된 형식

생성자 개요

ArrayBlockingQueue (int capacity)
지정된 (고정) 용량 및 디폴트의 액세스 정책를 사용해, ArrayBlockingQueue를 작성합니다.

ArrayBlockingQueue (int capacity, boolean fair)
지정된 (고정) 용량 및 지정된 액세스 정책를 사용해, ArrayBlockingQueue을 작성합니다.

ArrayBlockingQueue (int capacity, boolean fair, Collection <? extends E > c)
지정된 (고정) 용량 및 액세스 정책를 가져, 지정된 컬렉션의 요소를 최초로 포함한 ArrayBlockingQueue를 작성합니다.

메서드 개요

void	clear () 큐로부터 모든 요소를 원자적으로 삭제합니다.
boolean	contains (Object o) 컬렉션으로 지정된 요소가 있는 경우에 true를 리턴합니다.
int	drainTo (Collection <? super E > c) 이용 가능한 모든 요소를 이 큐로부터 삭제해, 지정된 컬렉션에 추가합니다.
int	drainTo (Collection <? super E > c, int maxElements) 지정된 수이내의 이용 가능한 요소를 이 큐로부터 삭제해, 지정된 컬렉션에 추가합니다.
Iterator <E >	iterator () 큐내의 요소를 적절한 순서로 반복 처리 하는 반복자를 리턴합니다.
boolean	offer (E o) 가능하면, 이 큐의 말미로 지정된 요소를 삽입합니다.
boolean	offer (E o, long timeout, TimeUnit unit) 지정된 요소를 이 큐의 말미에 삽입합니다.
E	peek () 큐의 선두를 취득합니다만, 삭제하지 않습니다.
E	poll () 큐의 선두를 취득 및 삭제합니다.
E	poll (long timeout, TimeUnit unit) 이 큐의 선두를 취득 및 삭제합니다.
void	put (E o) 지정된 요소를 이 큐의 말미에 추가합니다.
int	remainingCapacity () 이 큐가 이상적인 상태에 있는 (메모리나 자원의 제한이 존재하지 않는다) 경우에 블로킹없이 받아들이는 요소의 수를 리턴합니다.
boolean	remove (Object o) 지정된 요소의 단일의 인스턴스가 있는 경우는 큐로부터 삭제합니다.
int	size () 큐내에 있는 요소의 수를 리턴합니다.
E	take () 이 큐의 선두를 취득 및 삭제합니다.
Object []	toArray () 이 컬렉션의 요소가 모두 포함되고 있는 배열을 리턴합니다.
<T> T[]	toArray (T[] a) 이 컬렉션내의 모든 요소를 보관 유지하는 배열을 리턴합니다.
String	toString () 이 컬렉션의 캐릭터 라인 표현을 리턴합니다.

클래스 java.util. AbstractQueue 로부터 상속된 메서드

add, addAll, element, remove

클래스 java.util. AbstractCollection 로부터 상속된 메서드

containsAll, isEmpty, removeAll, retainAll

클래스 java.lang. Object 로부터 상속된 메서드

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

인터페이스 java.util.concurrent. BlockingQueue 로부터 상속된 메서드

add

인터페이스 java.util. Queue 로부터 상속된 메서드

element, remove

인터페이스 java.util. Collection 로부터 상속된 메서드

addAll, containsAll, equals, hashCode, isEmpty, removeAll, retainAll

생성자 상세

ArrayBlockingQueue

public ArrayBlockingQueue(int capacity)

지정된 (고정) 용량 및 디폴트의 액세스 정책를 사용해, ArrayBlockingQueue를 작성합니다.

파라미터:

capacity - 큐의 용량

예외:

IllegalArgumentException - capacity가 1 미만의 경우

ArrayBlockingQueue

public ArrayBlockingQueue(int capacity,
                          boolean fair)

지정된 (고정) 용량 및 지정된 액세스 정책를 사용해, ArrayBlockingQueue를 작성합니다.

파라미터:

capacity - 큐의 용량

fair - true인 경우, 삽입 또는 삭제시에 블록 된 thread에 대한 큐 액세스는 FIFO 순서로 처리됩니다. false인 경우, 액세스 순서는 지정되지 않습니다.

예외:

IllegalArgumentException - capacity가 1 미만의 경우

ArrayBlockingQueue

public ArrayBlockingQueue(int capacity,
                          boolean fair,
                          Collection <?  extends E > c)

지정된 (고정) 용량 및 액세스 정책를 가져, 지정된 컬렉션의 요소를 최초로 포함한 ArrayBlockingQueue를 작성합니다. 이것은 컬렉션의 반복자의 traversal order로 추가됩니다.

파라미터:

capacity - 큐의 용량

fair - true인 경우, 삽입 또는 삭제시에 블록 된 thread에 대한 큐 액세스는 FIFO 순서로 처리됩니다. false인 경우, 액세스 순서는 지정되지 않습니다.

c - 최초로 포함한 요소의 컬렉션

예외:

IllegalArgumentException - capacity가 c.size() 미만인지, 1 미만인 경우

NullPointerException - c 또는 그 내부 요소중 한쪽이 null인 경우

메서드의 상세

offer

public boolean offer(E  o)

가능하면, 이 큐의 말미로 지정된 요소를 삽입합니다. 이 큐가 가득해 있는 경우에는 즉석에서 리턴합니다.

정의:

인터페이스 BlockingQueue <E > 내의 offer

정의:

인터페이스 Queue <E > 내의 offer

파라미터:

o - 추가하는 요소

반환값:

요소를 이 큐에 추가 가능한 경우는 true, 그렇지 않은 경우는 false

예외:

NullPointerException - 지정된 요소가 null 인 경우

offer

public boolean offer(E  o,
                     long timeout,
                     TimeUnit  unit)
              throws InterruptedException 

지정된 요소를 이 큐의 말미에 삽입합니다. 필요하게 응해 공간이 이용 가능하게 되는 것을 지정된 시간까지 대기합니다.

정의:

인터페이스 BlockingQueue <E > 내의 offer

파라미터:

o - 추가하는 요소

timeout - 처리를 중지할 때까지의 대기 시간. 단위는 unit

unit - timeout 파라미터의 해석 방법을 지정하는 TimeUnit

반환값:

성공했을 경우는 true, 공간이 이용 가능하게 되기 전으로 지정된 대기 시간이 경과했을 경우는 false

예외:

InterruptedException - 대기중에 인터럽트가 발생했을 경우

NullPointerException - 지정된 요소가 null 인 경우

poll

public E  poll()

인터페이스 Queue 기술:

큐의 선두를 취득 및 삭제합니다. 큐가 비어있는 경우는 null을 리턴합니다.

정의:

인터페이스 Queue <E > 내의 poll

반환값:

큐의 선두. 큐가 비어있는 경우는 null

poll

public E  poll(long timeout,
              TimeUnit  unit)
       throws InterruptedException 

인터페이스 BlockingQueue 기술:

이 큐의 선두를 취득 및 삭제합니다. 이 큐에 요소가 존재하지 않는 경우는 필요에 따라서 지정된 시간만 대기합니다.

정의:

인터페이스 BlockingQueue <E > 내의 poll

파라미터:

timeout - 처리를 중지할 때까지의 대기 시간. 단위는 unit

unit - timeout 파라미터의 해석 방법을 지정하는 TimeUnit

반환값:

이 큐의 선두. 지정된 대기 시간이 경과해도 요소가 존재하지 않는 경우는 null

예외:

InterruptedException - 대기중에 인터럽트가 발생했을 경우

remove

public boolean remove(Object  o)

지정된 요소의 단일의 인스턴스가 있는 경우는 큐로부터 삭제합니다.

정의:

인터페이스 Collection <E > 내의 remove

오버라이드(override):

클래스 AbstractCollection <E > 내의 remove

파라미터:

o - 컬렉션으로부터 삭제되는 요소 (그 요소가 있는 경우)

반환값:

컬렉션으로 지정된 요소가 있는 경우는 true

peek

public E  peek()

인터페이스 Queue 기술:

큐의 선두를 취득합니다만, 삭제하지 않습니다. 큐가 비어있는 경우는 null을 리턴합니다.

정의:

인터페이스 Queue <E > 내의 peek

반환값:

큐의 선두. 큐가 비어있는 경우는 null

take

public E  take()
       throws InterruptedException 

인터페이스 BlockingQueue 기술:

이 큐의 선두를 취득 및 삭제합니다. 이 큐에 요소가 존재하지 않는 경우는 대기합니다.

정의:

인터페이스 BlockingQueue <E > 내의 take

반환값:

큐의 선두

예외:

InterruptedException - 대기중에 인터럽트가 발생했을 경우

put

public void put(E  o)
         throws InterruptedException 

지정된 요소를 이 큐의 말미에 추가합니다. 필요하게 응해 공간이 이용 가능하게 될 때까지 대기합니다.

정의:

인터페이스 BlockingQueue <E > 내의 put

파라미터:

o - 추가하는 요소

예외:

InterruptedException - 대기중에 인터럽트가 발생했을 경우

NullPointerException - 지정된 요소가 null 인 경우

size

public int size()

큐내에 있는 요소의 수를 리턴합니다.

정의:

인터페이스 Collection <E > 내의 size

정의:

클래스 AbstractCollection <E > 내의 size

반환값:

큐의 요소수

remainingCapacity

public int remainingCapacity()

이 큐가 이상적인 상태에 있는 (메모리나 자원의 제한이 존재하지 않는다) 경우에 블로킹없이 받아들이는 요소의 수를 리턴합니다. 이 값은 항상 이 큐의 초기 용량에 동일하고, 이 큐의 현재의 size 치보다 작아집니다.

remainingCapacity를 확인하면, 요소의 add 조작이 성공한다고는 반드시 말할 수 없습니다. 이것은 대기중의 컨슈머(consumer)가 다른 조작을 실행하면 가득 되어 버리는 큐에 대해서 요소의 take 조작을 실행할 준비가 되어 있는 경우가 있기 때문에입니다.

정의:

인터페이스 BlockingQueue <E > 내의 remainingCapacity

반환값:

나머지의 용량

contains

public boolean contains(Object  o)

클래스 AbstractCollection 기술:

컬렉션으로 지정된 요소가 있는 경우에 true를 리턴합니다. 즉, 이 컬렉션에 (o==null ? e==null : o.equals(e)) 인 요소 e가 1개 이상 있는 경우에만 true를 리턴합니다.

이 구현은 컬렉션의 각 요소에 대해, 지정된 요소와 동일한지 어떤지를 순서에 반복해 확인합니다.

정의:

인터페이스 Collection <E > 내의 contains

오버라이드(override):

클래스 AbstractCollection <E > 내의 contains

파라미터:

o - 이 컬렉션에 있을지 어떨지를 조사하는 객체

반환값:

컬렉션으로 지정된 요소가 있는 경우는 true

toArray

public Object [] toArray()

클래스 AbstractCollection 기술:

이 컬렉션의 요소가 모두 포함되고 있는 배열을 리턴합니다. 반복자에 의해 리턴된 요소의 차례를 컬렉션이 보증하는 경우, 이 메서드는 그것과 같은 차례로 요소를 리턴합니다. 리턴된 배열은 컬렉션에 의해 관리되는 참조 관계를 가지지 않는 점으로써 안전성이 보증됩니다. 즉, 이 메서드는 컬렉션의 기가 Array 인 경우에서도, 새롭게 배열을 할당합니다. 이 때문에 호출측은 리턴된 배열을 자유롭게 변경할 수 있습니다.

이 구현은 리턴된 배열을 할당해 컬렉션의 각 요소에 대해 반복합니다. 즉, 각 객체 참조를 배열의 다음의 요소에 포함한다고 하는 처리를, 제 0 요소로부터 개시합니다.

정의:

인터페이스 Collection <E > 내의 toArray

오버라이드(override):

클래스 AbstractCollection <E > 내의 toArray

반환값:

컬렉션의 모든 요소가 포함되고 있는 배열

toArray

public <T> T[] toArray(T[] a)

클래스 AbstractCollection 기술:

이 컬렉션내의 모든 요소를 보관 유지하는 배열을 리턴합니다. 리턴된 배열의 실행시의 형태는 지정된 배열의 형태입니다. 컬렉션이 지정된 배열에 들어가는 경우는 그 중에 리턴됩니다 . 그렇지 않은 경우는 지정된 배열의 실행시의 형태와 컬렉션의 사이즈를 가지는 새로운 배열을 할당할 수 있습니다.

지정된 배열에 컬렉션이 들어가 또한 빈 곳이 있는 경우, 즉 배열에 컬렉션 이상의 요소수 있는인 경우에는 컬렉션의 종단의 직후에 있는 배열의 요소가 null로 설정됩니다. 컬렉션에 null 요소가 없는 것이 호출해 옆으로 밝혀지고 있는 경우에는 이것에 의해 컬렉션의 길이를 판정할 수 있습니다.

반복자에 의해 요소가 리턴된 순서를 컬렉션이 보증하는 경우, 이 메서드는 같은 순서로 요소를 돌려주지 않으면 안됩니다.

이 구현은 배열이 컬렉션의 포함에 충분한 크기인지를 확인합니다. 불충분한 경우, 이 구현은 리플렉션을 사용해, 적절한 사이즈 및 형태의 배열을 새롭게 할당합니다. 다음에 컬렉션에 대해서 0 으로부터 순서에 배열이 연속하는 요소에 각 객체 참조를 포함하는 조작을 반복합니다. 배열이 컬렉션보다 큰 경우, 컬렉션의 종단보다 후의 최초의 위치에 null가 포함됩니다.

정의:

인터페이스 Collection <E > 내의 toArray

오버라이드(override):

클래스 AbstractCollection <E > 내의 toArray

파라미터:

a - 컬렉션의 요소의 포함처의 배열. 배열의 사이즈가 충분하지 않은 경우는 같은 실행시의 형태로 새로운 배열이 포함용으로서 할당할 수 있다

반환값:

컬렉션의 요소를 포함한 배열

toString

public String  toString()

클래스 AbstractCollection 기술:

이 컬렉션의 캐릭터 라인 표현을 리턴합니다. 캐릭터 라인 표현은 컬렉션의 요소를 그 반복자가 돌려준 순서에 꺽쇄묶음 ("[]")으로 둘러싸 가리키는 리스트입니다. 인접하는 요소는 문자 ", " (칸마와 공백 문자)에 의해 단락지어집니다. 각 요소는 String.valueOf(Object)를 실행했는지와 같이 캐릭터 라인에 변환됩니다.

이 구현은 비어있는 캐릭터 라인 버퍼를 작성해, 최초로 왼쪽 꺽쇄묶음을 부가하고 나서, 컬렉션의 내용을 차례차례 조사해, 각 요소의 캐릭터 라인 표현을 순서에 부가해 갈 것입니다. 각 요소의 뒤에는 캐릭터 라인 ", " 이 부가됩니다. 다만, 마지막 요소의 뒤에는 ", "는 아니고 오른쪽 꺽쇄묶음이 부가됩니다. 마지막에 캐릭터 라인 버퍼로부터 캐릭터 라인을 취득해, 그 캐릭터 라인을 리턴합니다.

오버라이드(override):

클래스 AbstractCollection <E > 내의 toString

반환값:

이 컬렉션의 캐릭터 라인 표현

clear

public void clear()

큐로부터 모든 요소를 원자적으로 삭제합니다. 이 호출이 돌아오면, 큐는 비웁니다.

정의:

인터페이스 Collection <E > 내의 clear

오버라이드(override):

클래스 AbstractQueue <E > 내의 clear

drainTo

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

인터페이스 BlockingQueue 기술:

이용 가능한 모든 요소를 이 큐로부터 삭제해, 지정된 컬렉션에 추가합니다. 이 조작은 이 큐를 반복해 폴링 하는 경우보다 효율적인 경우가 있습니다. 컬렉션 c에 요소의 add 조작을 시도할 때에 장해가 발생했을 경우, 관련된 예외의 Throw시에 요소가 컬렉션의 어느 것에도 존재하지 않는지, 한편 또는 양쪽 모두에 존재할 가능성이 있습니다. 큐를 자기 자신에게 배출하는 것을 시도하면, IllegalArgumentException이 발생 됩니다. 또, 이 조작의 진행중으로 지정된 컬렉션이 변경되었을 경우의 동작은 정의되지 않습니다.

정의:

인터페이스 BlockingQueue <E > 내의 drainTo

파라미터:

c - 요소의 전송처의 컬렉션

반환값:

전송 되는 요소의 수

drainTo

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

인터페이스 BlockingQueue 기술:

지정된 수이내의 이용 가능한 요소를 이 큐로부터 삭제해, 지정된 컬렉션에 추가합니다. 컬렉션 c에 요소의 add 조작을 시도할 때에 장해가 발생했을 경우, 관련된 예외의 Throw시에 요소가 컬렉션의 어느 것에도 존재하지 않는지, 한편 또는 양쪽 모두에 존재할 가능성이 있습니다. 큐를 자기 자신에게 배출하는 것을 시도하면, IllegalArgumentException이 발생 됩니다. 또, 이 조작의 진행중으로 지정된 컬렉션이 변경되었을 경우의 동작은 정의되지 않습니다.

정의:

인터페이스 BlockingQueue <E > 내의 drainTo

파라미터:

c - 요소의 전송처의 컬렉션

maxElements - 전송 하는 요소의 최대수

반환값:

전송 되는 요소의 수

iterator

public Iterator <E > iterator()

큐내의 요소를 적절한 순서로 반복 처리 하는 반복자를 리턴합니다. 리턴된 Iterator는 「약일관성」을 가지는 반복자이며, ConcurrentModificationException를 Throw 하는 것은 결코 없고, 반복자의 구축시에 존재한 요소를 전탐색하는 것을 보증합니다. 또, 구축 후의 모든 변경을 반영하는 일도 가능합니다 (다만 보증되지는 않았다).

정의:

인터페이스 Iterable <E > 내의 iterator

정의:

인터페이스 Collection <E > 내의 iterator

정의:

클래스 AbstractCollection <E > 내의 iterator

반환값:

큐내의 요소를 적절한 순서로 반복 처리 하는 반복자