src/share/jaxws_classes/com/sun/istack/internal/Pool.java

Tue, 06 Mar 2012 16:09:35 -0800

author
ohair
date
Tue, 06 Mar 2012 16:09:35 -0800
changeset 286
f50545b5e2f1
child 368
0989ad8c0860
permissions
-rw-r--r--

7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom

ohair@286 1 /*
ohair@286 2 * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.istack.internal;
ohair@286 27
ohair@286 28 import java.util.concurrent.ConcurrentLinkedQueue;
ohair@286 29 import java.lang.ref.WeakReference;
ohair@286 30
ohair@286 31 /**
ohair@286 32 * Pool of reusable objects that are indistinguishable from each other,
ohair@286 33 * such as JAXB marshallers.
ohair@286 34 *
ohair@286 35 * @author Kohsuke Kawaguchi
ohair@286 36 */
ohair@286 37 public interface Pool<T> {
ohair@286 38
ohair@286 39 /**
ohair@286 40 * Gets a new object from the pool.
ohair@286 41 *
ohair@286 42 * <p>
ohair@286 43 * If no object is available in the pool, this method creates a new one.
ohair@286 44 */
ohair@286 45 @NotNull T take();
ohair@286 46
ohair@286 47 /**
ohair@286 48 * Returns an object back to the pool.
ohair@286 49 */
ohair@286 50 void recycle(@NotNull T t);
ohair@286 51
ohair@286 52 /**
ohair@286 53 * Default implementation that uses {@link ConcurrentLinkedQueue}
ohair@286 54 * as the data store.
ohair@286 55 *
ohair@286 56 * <h2>Note for Implementors</h2>
ohair@286 57 * <p>
ohair@286 58 * Don't rely on the fact that this class extends from {@link ConcurrentLinkedQueue}.
ohair@286 59 */
ohair@286 60 public abstract class Impl<T> implements Pool<T> {
ohair@286 61
ohair@286 62 private volatile WeakReference<ConcurrentLinkedQueue<T>> queue;
ohair@286 63
ohair@286 64 /**
ohair@286 65 * Gets a new object from the pool.
ohair@286 66 *
ohair@286 67 * <p>
ohair@286 68 * If no object is available in the pool, this method creates a new one.
ohair@286 69 *
ohair@286 70 * @return
ohair@286 71 * always non-null.
ohair@286 72 */
ohair@286 73 public final @NotNull T take() {
ohair@286 74 T t = getQueue().poll();
ohair@286 75 if(t==null) {
ohair@286 76 return create();
ohair@286 77 }
ohair@286 78 return t;
ohair@286 79 }
ohair@286 80
ohair@286 81 /**
ohair@286 82 * Returns an object back to the pool.
ohair@286 83 */
ohair@286 84 public final void recycle(T t) {
ohair@286 85 getQueue().offer(t);
ohair@286 86 }
ohair@286 87
ohair@286 88 private ConcurrentLinkedQueue<T> getQueue() {
ohair@286 89 WeakReference<ConcurrentLinkedQueue<T>> q = queue;
ohair@286 90 if (q != null) {
ohair@286 91 ConcurrentLinkedQueue<T> d = q.get();
ohair@286 92 if (d != null) {
ohair@286 93 return d;
ohair@286 94 }
ohair@286 95 }
ohair@286 96 // overwrite the queue
ohair@286 97 ConcurrentLinkedQueue<T> d = new ConcurrentLinkedQueue<T>();
ohair@286 98 queue = new WeakReference<ConcurrentLinkedQueue<T>>(d);
ohair@286 99
ohair@286 100 return d;
ohair@286 101 }
ohair@286 102
ohair@286 103 /**
ohair@286 104 * Creates a new instance of object.
ohair@286 105 *
ohair@286 106 * <p>
ohair@286 107 * This method is used when someone wants to
ohair@286 108 * {@link #take() take} an object from an empty pool.
ohair@286 109 *
ohair@286 110 * <p>
ohair@286 111 * Also note that multiple threads may call this method
ohair@286 112 * concurrently.
ohair@286 113 */
ohair@286 114 protected abstract @NotNull T create();
ohair@286 115 }
ohair@286 116 }

mercurial