mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/conn/tsccm/BasicPoolEntryRef.java

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/conn/tsccm/BasicPoolEntryRef.java	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,81 @@
     1.4 +/*
     1.5 + * ====================================================================
     1.6 + *
     1.7 + *  Licensed to the Apache Software Foundation (ASF) under one or more
     1.8 + *  contributor license agreements.  See the NOTICE file distributed with
     1.9 + *  this work for additional information regarding copyright ownership.
    1.10 + *  The ASF licenses this file to You under the Apache License, Version 2.0
    1.11 + *  (the "License"); you may not use this file except in compliance with
    1.12 + *  the License.  You may obtain a copy of the License at
    1.13 + *
    1.14 + *      http://www.apache.org/licenses/LICENSE-2.0
    1.15 + *
    1.16 + *  Unless required by applicable law or agreed to in writing, software
    1.17 + *  distributed under the License is distributed on an "AS IS" BASIS,
    1.18 + *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    1.19 + *  See the License for the specific language governing permissions and
    1.20 + *  limitations under the License.
    1.21 + * ====================================================================
    1.22 + *
    1.23 + * This software consists of voluntary contributions made by many
    1.24 + * individuals on behalf of the Apache Software Foundation.  For more
    1.25 + * information on the Apache Software Foundation, please see
    1.26 + * <http://www.apache.org/>.
    1.27 + *
    1.28 + */
    1.29 +
    1.30 +package ch.boye.httpclientandroidlib.impl.conn.tsccm;
    1.31 +
    1.32 +
    1.33 +import java.lang.ref.WeakReference;
    1.34 +import java.lang.ref.ReferenceQueue;
    1.35 +
    1.36 +import ch.boye.httpclientandroidlib.annotation.Immutable;
    1.37 +
    1.38 +import ch.boye.httpclientandroidlib.conn.routing.HttpRoute;
    1.39 +
    1.40 +
    1.41 +
    1.42 +/**
    1.43 + * A weak reference to a {@link BasicPoolEntry BasicPoolEntry}.
    1.44 + * This reference explicitly keeps the planned route, so the connection
    1.45 + * can be reclaimed if it is lost to garbage collection.
    1.46 + *
    1.47 + * @since 4.0
    1.48 + */
    1.49 +@Immutable
    1.50 +public class BasicPoolEntryRef extends WeakReference<BasicPoolEntry> {
    1.51 +
    1.52 +    /** The planned route of the entry. */
    1.53 +    private final HttpRoute route; // HttpRoute is @Immutable
    1.54 +
    1.55 +
    1.56 +    /**
    1.57 +     * Creates a new reference to a pool entry.
    1.58 +     *
    1.59 +     * @param entry   the pool entry, must not be <code>null</code>
    1.60 +     * @param queue   the reference queue, or <code>null</code>
    1.61 +     */
    1.62 +    public BasicPoolEntryRef(BasicPoolEntry entry,
    1.63 +                             ReferenceQueue<Object> queue) {
    1.64 +        super(entry, queue);
    1.65 +        if (entry == null) {
    1.66 +            throw new IllegalArgumentException
    1.67 +                ("Pool entry must not be null.");
    1.68 +        }
    1.69 +        route = entry.getPlannedRoute();
    1.70 +    }
    1.71 +
    1.72 +
    1.73 +    /**
    1.74 +     * Obtain the planned route for the referenced entry.
    1.75 +     * The planned route is still available, even if the entry is gone.
    1.76 +     *
    1.77 +     * @return      the planned route
    1.78 +     */
    1.79 +    public final HttpRoute getRoute() {
    1.80 +        return this.route;
    1.81 +    }
    1.82 +
    1.83 +} // class BasicPoolEntryRef
    1.84 +

mercurial