mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/conn/tsccm/BasicPoolEntryRef.java@b8a032363ba2 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/conn/tsccm/BasicPoolEntryRef.java
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* |
| michael@0 | 2 | * ==================================================================== |
| michael@0 | 3 | * |
| michael@0 | 4 | * Licensed to the Apache Software Foundation (ASF) under one or more |
| michael@0 | 5 | * contributor license agreements. See the NOTICE file distributed with |
| michael@0 | 6 | * this work for additional information regarding copyright ownership. |
| michael@0 | 7 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
| michael@0 | 8 | * (the "License"); you may not use this file except in compliance with |
| michael@0 | 9 | * the License. You may obtain a copy of the License at |
| michael@0 | 10 | * |
| michael@0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| michael@0 | 12 | * |
| michael@0 | 13 | * Unless required by applicable law or agreed to in writing, software |
| michael@0 | 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
| michael@0 | 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| michael@0 | 16 | * See the License for the specific language governing permissions and |
| michael@0 | 17 | * limitations under the License. |
| michael@0 | 18 | * ==================================================================== |
| michael@0 | 19 | * |
| michael@0 | 20 | * This software consists of voluntary contributions made by many |
| michael@0 | 21 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 22 | * information on the Apache Software Foundation, please see |
| michael@0 | 23 | * <http://www.apache.org/>. |
| michael@0 | 24 | * |
| michael@0 | 25 | */ |
| michael@0 | 26 | |
| michael@0 | 27 | package ch.boye.httpclientandroidlib.impl.conn.tsccm; |
| michael@0 | 28 | |
| michael@0 | 29 | |
| michael@0 | 30 | import java.lang.ref.WeakReference; |
| michael@0 | 31 | import java.lang.ref.ReferenceQueue; |
| michael@0 | 32 | |
| michael@0 | 33 | import ch.boye.httpclientandroidlib.annotation.Immutable; |
| michael@0 | 34 | |
| michael@0 | 35 | import ch.boye.httpclientandroidlib.conn.routing.HttpRoute; |
| michael@0 | 36 | |
| michael@0 | 37 | |
| michael@0 | 38 | |
| michael@0 | 39 | /** |
| michael@0 | 40 | * A weak reference to a {@link BasicPoolEntry BasicPoolEntry}. |
| michael@0 | 41 | * This reference explicitly keeps the planned route, so the connection |
| michael@0 | 42 | * can be reclaimed if it is lost to garbage collection. |
| michael@0 | 43 | * |
| michael@0 | 44 | * @since 4.0 |
| michael@0 | 45 | */ |
| michael@0 | 46 | @Immutable |
| michael@0 | 47 | public class BasicPoolEntryRef extends WeakReference<BasicPoolEntry> { |
| michael@0 | 48 | |
| michael@0 | 49 | /** The planned route of the entry. */ |
| michael@0 | 50 | private final HttpRoute route; // HttpRoute is @Immutable |
| michael@0 | 51 | |
| michael@0 | 52 | |
| michael@0 | 53 | /** |
| michael@0 | 54 | * Creates a new reference to a pool entry. |
| michael@0 | 55 | * |
| michael@0 | 56 | * @param entry the pool entry, must not be <code>null</code> |
| michael@0 | 57 | * @param queue the reference queue, or <code>null</code> |
| michael@0 | 58 | */ |
| michael@0 | 59 | public BasicPoolEntryRef(BasicPoolEntry entry, |
| michael@0 | 60 | ReferenceQueue<Object> queue) { |
| michael@0 | 61 | super(entry, queue); |
| michael@0 | 62 | if (entry == null) { |
| michael@0 | 63 | throw new IllegalArgumentException |
| michael@0 | 64 | ("Pool entry must not be null."); |
| michael@0 | 65 | } |
| michael@0 | 66 | route = entry.getPlannedRoute(); |
| michael@0 | 67 | } |
| michael@0 | 68 | |
| michael@0 | 69 | |
| michael@0 | 70 | /** |
| michael@0 | 71 | * Obtain the planned route for the referenced entry. |
| michael@0 | 72 | * The planned route is still available, even if the entry is gone. |
| michael@0 | 73 | * |
| michael@0 | 74 | * @return the planned route |
| michael@0 | 75 | */ |
| michael@0 | 76 | public final HttpRoute getRoute() { |
| michael@0 | 77 | return this.route; |
| michael@0 | 78 | } |
| michael@0 | 79 | |
| michael@0 | 80 | } // class BasicPoolEntryRef |
| michael@0 | 81 |
