com.helger.scope.singleton.AbstractGlobalSingleton Maven / Gradle / Ivy

Go to download
/*
 * 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.scope.singleton;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.scope.IGlobalScope;
import com.helger.scope.mgr.ScopeManager;

/**
 * This is the base class for singleton objects that reside in the global scope.
 * The global scope is identical for web scope and non-web scope applications.
 *
 * @see com.helger.scope.mgr.EScope#GLOBAL
 * @author Philip Helger
 */
public abstract class AbstractGlobalSingleton extends AbstractSingleton
{
  protected AbstractGlobalSingleton ()
  {}

  /**
   * @param bMustBePresent
   *        true if a global scope must be present,
   *        false if it is optional
   * @return The scope to be used for this type of singleton.
   */
  @Nonnull
  private static IGlobalScope _getStaticScope (final boolean bMustBePresent)
  {
    return bMustBePresent ? ScopeManager.getGlobalScope () : ScopeManager.getGlobalScopeOrNull ();
  }

  /**
   * Get the singleton object in the current global scope, using the passed
   * class. If the singleton is not yet instantiated, a new instance is created.
   *
   * @param 
   *        The type to be returned
   * @param aClass
   *        The class to be used. May not be null. The class must
   *        be public as needs to have a public no-argument constructor.
   * @return The singleton object and never null.
   */
  @Nonnull
  public static final  T getGlobalSingleton (@Nonnull final Class  aClass)
  {
    return getSingleton (_getStaticScope (true), aClass);
  }

  /**
   * Get the singleton object if it is already instantiated inside the current
   * global scope or null if it is not instantiated.
   *
   * @param 
   *        The type to be returned
   * @param aClass
   *        The class to be checked. May not be null.
   * @return The singleton for the specified class is already instantiated,
   *         null otherwise.
   */
  @Nullable
  public static final  T getGlobalSingletonIfInstantiated (@Nonnull final Class  aClass)
  {
    return getSingletonIfInstantiated (_getStaticScope (false), aClass);
  }

  /**
   * Check if a singleton is already instantiated inside the current global
   * scope
   *
   * @param aClass
   *        The class to be checked. May not be null.
   * @return true if the singleton for the specified class is
   *         already instantiated, false otherwise.
   */
  public static final boolean isGlobalSingletonInstantiated (@Nonnull final Class  aClass)
  {
    return isSingletonInstantiated (_getStaticScope (false), aClass);
  }

  /**
   * Get all instantiated singleton objects registered in the current global
   * scope.
   *
   * @return A non-null list with all instances of this class in
   *         the current global scope.
   */
  @Nonnull
  @ReturnsMutableCopy
  public static final ICommonsList  getAllGlobalSingletons ()
  {
    return getAllSingletons (_getStaticScope (false), AbstractGlobalSingleton.class);
  }
}