| 1 | /*
|
|---|
| 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
|
|---|
| 3 | *
|
|---|
| 4 | * Copyright (c) 2013-2017 Oracle and/or its affiliates. All rights reserved.
|
|---|
| 5 | *
|
|---|
| 6 | * The contents of this file are subject to the terms of either the GNU
|
|---|
| 7 | * General Public License Version 2 only ("GPL") or the Common Development
|
|---|
| 8 | * and Distribution License("CDDL") (collectively, the "License"). You
|
|---|
| 9 | * may not use this file except in compliance with the License. You can
|
|---|
| 10 | * obtain a copy of the License at
|
|---|
| 11 | * https://oss.oracle.com/licenses/CDDL+GPL-1.1
|
|---|
| 12 | * or LICENSE.txt. See the License for the specific
|
|---|
| 13 | * language governing permissions and limitations under the License.
|
|---|
| 14 | *
|
|---|
| 15 | * When distributing the software, include this License Header Notice in each
|
|---|
| 16 | * file and include the License file at LICENSE.txt.
|
|---|
| 17 | *
|
|---|
| 18 | * GPL Classpath Exception:
|
|---|
| 19 | * Oracle designates this particular file as subject to the "Classpath"
|
|---|
| 20 | * exception as provided by Oracle in the GPL Version 2 section of the License
|
|---|
| 21 | * file that accompanied this code.
|
|---|
| 22 | *
|
|---|
| 23 | * Modifications:
|
|---|
| 24 | * If applicable, add the following below the License Header, with the fields
|
|---|
| 25 | * enclosed by brackets [] replaced by your own identifying information:
|
|---|
| 26 | * "Portions Copyright [year] [name of copyright owner]"
|
|---|
| 27 | *
|
|---|
| 28 | * Contributor(s):
|
|---|
| 29 | * If you wish your version of this file to be governed by only the CDDL or
|
|---|
| 30 | * only the GPL Version 2, indicate your decision by adding "[Contributor]
|
|---|
| 31 | * elects to include this software in this distribution under the [CDDL or GPL
|
|---|
| 32 | * Version 2] license." If you don't indicate a single choice of license, a
|
|---|
| 33 | * recipient has the option to distribute your version of this file under
|
|---|
| 34 | * either the CDDL, the GPL Version 2 or to extend the choice of license to
|
|---|
| 35 | * its licensees as provided above. However, if you add GPL Version 2 code
|
|---|
| 36 | * and therefore, elected the GPL Version 2 license, then the option applies
|
|---|
| 37 | * only if the new code is made subject to such option by the copyright
|
|---|
| 38 | * holder.
|
|---|
| 39 | */
|
|---|
| 40 |
|
|---|
| 41 | package org.glassfish.json.api;
|
|---|
| 42 |
|
|---|
| 43 | /**
|
|---|
| 44 | * char[] pool that pool instances of char[] which are expensive to create.
|
|---|
| 45 | *
|
|---|
| 46 | * @author Jitendra Kotamraju
|
|---|
| 47 | */
|
|---|
| 48 | public interface BufferPool {
|
|---|
| 49 |
|
|---|
| 50 | /**
|
|---|
| 51 | * Gets a new char[] object from the pool.
|
|---|
| 52 | *
|
|---|
| 53 | * <p>
|
|---|
| 54 | * If no object is available in the pool, this method creates a new one.
|
|---|
| 55 | *
|
|---|
| 56 | * @return
|
|---|
| 57 | * always non-null.
|
|---|
| 58 | */
|
|---|
| 59 | char[] take();
|
|---|
| 60 |
|
|---|
| 61 | /**
|
|---|
| 62 | * Returns an object back to the pool.
|
|---|
| 63 | *
|
|---|
| 64 | * @param buf object to return back to the pool
|
|---|
| 65 | */
|
|---|
| 66 | void recycle(char[] buf);
|
|---|
| 67 |
|
|---|
| 68 | }
|
|---|
