View Javadoc
1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  package org.apache.hc.core5.http.protocol;
28  
29  /**
30   * A lookup registry.
31   *
32   * @param <T> The type of objects to register and lookup.
33   */
34  public interface LookupRegistry<T> {
35  
36      /**
37       * Registers the given object for URIs matching the given pattern.
38       *
39       * @param pattern the pattern to register the handler for.
40       * @param obj the object.
41       */
42      void register(String pattern, T obj);
43  
44      /**
45       * Looks up an object matching the given request path.
46       *
47       * @param value the request path
48       * @return object or {@code null} if no match is found.
49       */
50      T lookup(String value);
51  
52      /**
53       * Removes registered object, if exists, for the given pattern.
54       *
55       * @param pattern the pattern to unregister.
56       */
57      void unregister(String pattern);
58  
59  }