1 /*
2 * Copyright 2015 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty.channel.pool;
17
18 /**
19 * Allows to map {@link ChannelPool} implementations to a specific key.
20 *
21 * @param <K> the type of the key
22 * @param <P> the type of the {@link ChannelPool}
23 */
24 public interface ChannelPoolMap<K, P extends ChannelPool> {
25 /**
26 * Return the {@link ChannelPool} for the {@code code}. This will never return {@code null},
27 * but create a new {@link ChannelPool} if non exists for they requested {@code key}.
28 *
29 * Please note that {@code null} keys are not allowed.
30 */
31 P get(K key);
32
33 /**
34 * Returns {@code true} if a {@link ChannelPool} exists for the given {@code key}.
35 *
36 * Please note that {@code null} keys are not allowed.
37 */
38 boolean contains(K key);
39 }