com.helger.commons.pool.IObjectPoolFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation
Java 1.8+ Library with tons of utility classes required in all projects
The newest version!
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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 com.helger.commons.pool;

import java.util.function.Supplier;

import javax.annotation.Nonnull;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.state.ESuccess;

/**
 * An extended factory for objects in the {@link ObjectPool}.
 *
 * @author Philip Helger
 * @param 
 *        the type of results supplied by this factory
 * @since 11.1.0
 */
public interface IObjectPoolFactory 
{
  /**
   * Create a new object for usage in the pool. This method is called if no
   * object is in the pool, or if activation of a pooled object failed.
   *
   * @return A new object of data type. Never null.
   */
  @Nonnull
  DATATYPE create ();

  /**
   * Called when an existing object is borrowed from the pool. If activation
   * failed, a new object will be created.
   *
   * @param aItem
   *        The item to be borrowed. Never null.
   * @return {@link ESuccess#SUCCESS} if the object can be reused,
   *         {@link ESuccess#FAILURE} if not.
   */
  @Nonnull
  ESuccess activate (@Nonnull DATATYPE aItem);

  /**
   * Called when an object is returned to the pool. This method has no return
   * value - only {@link #activate(Object)} can change the path.
   *
   * @param aItem
   *        The item to be returned. Never null.
   */
  void passivate (@Nonnull DATATYPE aItem);

  /**
   * Wrapper around {@link Supplier} to create an {@link IObjectPoolFactory}.
   *
   * @param 
   *        Type the object pool is supplying.
   * @param aSupplier
   *        The supplier to wrap. May not be null.
   * @return A new instance of {@link IObjectPoolFactory}.
   */
  @Nonnull
  static  IObjectPoolFactory  wrap (@Nonnull final Supplier  aSupplier)
  {
    ValueEnforcer.notNull (aSupplier, "Supplier");

    return new IObjectPoolFactory <> ()
    {
      @Nonnull
      public T create ()
      {
        return aSupplier.get ();
      }

      @Nonnull
      public ESuccess activate (@Nonnull final T aItem)
      {
        // empty
        return ESuccess.SUCCESS;
      }

      public void passivate (@Nonnull final T aItem)
      {
        // empty
      }
    };
  }
}