com.helger.commons.factory.FactoryNewInstance 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

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2022 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.factory;

import java.util.function.Supplier;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.lang.ClassHelper;
import com.helger.commons.lang.GenericReflection;
import com.helger.commons.string.ToStringGenerator;

/**
 * Implementation of {@link Supplier} that always creates a new instance via
 * reflection
 *
 * @author Philip Helger
 * @param 
 *        The return type of the factory
 */
@Immutable
public class FactoryNewInstance  implements Supplier 
{
  private final Class  m_aClass;

  public FactoryNewInstance (@Nullable final Class  aClass, final boolean bCheckInstancable)
  {
    if (bCheckInstancable)
      ValueEnforcer.isTrue (ClassHelper.isInstancableClass (aClass),
                            () -> "The passed class '" + aClass + "' is not instancable or doesn't have a public no-argument constructor!");
    m_aClass = aClass;
  }

  @Nullable
  public Class  getFactoryClass ()
  {
    return m_aClass;
  }

  @Nullable
  public DATATYPE get ()
  {
    return GenericReflection.newInstance (m_aClass);
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (o == null || !getClass ().equals (o.getClass ()))
      return false;
    final FactoryNewInstance  rhs = (FactoryNewInstance ) o;
    return EqualsHelper.equals (m_aClass, rhs.m_aClass);
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).append (m_aClass).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("Class", m_aClass).getToString ();
  }

  @Nonnull
  public static  FactoryNewInstance  create (@Nullable final Class  aClass)
  {
    return create (aClass, false);
  }

  @Nonnull
  public static  FactoryNewInstance  create (@Nullable final Class  aClass, final boolean bCheckInstancable)
  {
    return new FactoryNewInstance <> (aClass, bCheckInstancable);
  }
}