001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.async;
018
019import java.util.concurrent.BlockingQueue;
020
021/**
022 * Factory for creating instances of {@link BlockingQueue}.
023 *
024 * @since 2.7
025 */
026public interface BlockingQueueFactory<E> {
027
028    /**
029     * The {@link org.apache.logging.log4j.core.config.plugins.Plugin#elementType() element type} to use for plugins
030     * implementing this interface.
031     */
032    String ELEMENT_TYPE = "BlockingQueueFactory";
033
034    /**
035     * Creates a new BlockingQueue with the specified maximum capacity. Note that not all implementations of
036     * BlockingQueue support a bounded capacity in which case the value is ignored.
037     *
038     * @param capacity maximum size of the queue if supported
039     * @return a new BlockingQueue
040     */
041    BlockingQueue<E> create(int capacity);
042}