1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.async;
18
19 import java.util.concurrent.BlockingQueue;
20
21 /**
22 * Factory for creating instances of {@link BlockingQueue}.
23 *
24 * @since 2.7
25 */
26 public interface BlockingQueueFactory<E> {
27
28 /**
29 * The {@link org.apache.logging.log4j.core.config.plugins.Plugin#elementType() element type} to use for plugins
30 * implementing this interface.
31 */
32 String ELEMENT_TYPE = "BlockingQueueFactory";
33
34 /**
35 * Creates a new BlockingQueue with the specified maximum capacity. Note that not all implementations of
36 * BlockingQueue support a bounded capacity in which case the value is ignored.
37 *
38 * @param capacity maximum size of the queue if supported
39 * @return a new BlockingQueue
40 */
41 BlockingQueue<E> create(int capacity);
42 }