michael@0: /*
michael@0:  * ====================================================================
michael@0:  *
michael@0:  *  Licensed to the Apache Software Foundation (ASF) under one or more
michael@0:  *  contributor license agreements.  See the NOTICE file distributed with
michael@0:  *  this work for additional information regarding copyright ownership.
michael@0:  *  The ASF licenses this file to You under the Apache License, Version 2.0
michael@0:  *  (the "License"); you may not use this file except in compliance with
michael@0:  *  the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *      http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  *  Unless required by applicable law or agreed to in writing, software
michael@0:  *  distributed under the License is distributed on an "AS IS" BASIS,
michael@0:  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0:  *  See the License for the specific language governing permissions and
michael@0:  *  limitations under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.impl.conn.tsccm;
michael@0: 
michael@0: 
michael@0: import java.lang.ref.WeakReference;
michael@0: import java.lang.ref.ReferenceQueue;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.annotation.Immutable;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.conn.routing.HttpRoute;
michael@0: 
michael@0: 
michael@0: 
michael@0: /**
michael@0:  * A weak reference to a {@link BasicPoolEntry BasicPoolEntry}.
michael@0:  * This reference explicitly keeps the planned route, so the connection
michael@0:  * can be reclaimed if it is lost to garbage collection.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: @Immutable
michael@0: public class BasicPoolEntryRef extends WeakReference<BasicPoolEntry> {
michael@0: 
michael@0:     /** The planned route of the entry. */
michael@0:     private final HttpRoute route; // HttpRoute is @Immutable
michael@0: 
michael@0: 
michael@0:     /**
michael@0:      * Creates a new reference to a pool entry.
michael@0:      *
michael@0:      * @param entry   the pool entry, must not be <code>null</code>
michael@0:      * @param queue   the reference queue, or <code>null</code>
michael@0:      */
michael@0:     public BasicPoolEntryRef(BasicPoolEntry entry,
michael@0:                              ReferenceQueue<Object> queue) {
michael@0:         super(entry, queue);
michael@0:         if (entry == null) {
michael@0:             throw new IllegalArgumentException
michael@0:                 ("Pool entry must not be null.");
michael@0:         }
michael@0:         route = entry.getPlannedRoute();
michael@0:     }
michael@0: 
michael@0: 
michael@0:     /**
michael@0:      * Obtain the planned route for the referenced entry.
michael@0:      * The planned route is still available, even if the entry is gone.
michael@0:      *
michael@0:      * @return      the planned route
michael@0:      */
michael@0:     public final HttpRoute getRoute() {
michael@0:         return this.route;
michael@0:     }
michael@0: 
michael@0: } // class BasicPoolEntryRef
michael@0: