dorkbox.objectPool.PoolableObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ObjectPool Show documentation

Fast, lightweight, and compatible blocking/non-blocking/soft-reference object pool for Java 8+

There is a newer version: 4.4

/*
 * Copyright 2014 dorkbox, llc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package dorkbox.objectPool;

public
abstract class PoolableObject {

    /**
     * Called when an object is returned to the pool, useful for resetting an objects state, for example.
     */
    @SuppressWarnings("UnusedParameters")
    public
    void onReturn(T object) {
    }

    /**
     * Called when an object is taken from the pool, useful for setting an objects state, for example.
     */
    @SuppressWarnings("UnusedParameters")
    public
    void onTake(T object) {
    }


    /**
     * Called when a new instance is created
     */
    public abstract T create();
}