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.http.impl.conn.tsccm;
28  
29  import java.lang.ref.ReferenceQueue;
30  import java.lang.ref.WeakReference;
31  
32  import org.apache.http.conn.routing.HttpRoute;
33  import org.apache.http.util.Args;
34  
35  /**
36   * A weak reference to a {@link BasicPoolEntry BasicPoolEntry}.
37   * This reference explicitly keeps the planned route, so the connection
38   * can be reclaimed if it is lost to garbage collection.
39   *
40   * @since 4.0
41   *
42   * @deprecated (4.2)  do not use
43   */
44  @Deprecated
45  public class BasicPoolEntryRef extends WeakReference<BasicPoolEntry> {
46  
47      /** The planned route of the entry. */
48      private final HttpRoute route; // HttpRoute is @Immutable
49  
50  
51      /**
52       * Creates a new reference to a pool entry.
53       *
54       * @param entry   the pool entry, must not be <code>null</code>
55       * @param queue   the reference queue, or <code>null</code>
56       */
57      public BasicPoolEntryRef(final BasicPoolEntry entry,
58                               final ReferenceQueue<Object> queue) {
59          super(entry, queue);
60          Args.notNull(entry, "Pool entry");
61          route = entry.getPlannedRoute();
62      }
63  
64  
65      /**
66       * Obtain the planned route for the referenced entry.
67       * The planned route is still available, even if the entry is gone.
68       *
69       * @return      the planned route
70       */
71      public final HttpRoute getRoute() {
72          return this.route;
73      }
74  
75  } // class BasicPoolEntryRef
76