com.phloc.commons.text.resolve.AbstractEnumTextResolverWithOverrideAndFallback Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-commons Show documentation
phloc very basic stuff
There is a newer version: 5.0.0
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[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.phloc.commons.text.resolve;

import java.util.Locale;

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

import com.phloc.commons.lang.EnumHelper;
import com.phloc.commons.stats.IStatisticsHandlerCounter;
import com.phloc.commons.stats.IStatisticsHandlerKeyedCounter;
import com.phloc.commons.stats.StatisticsManager;
import com.phloc.commons.text.ISimpleTextProvider;
import com.phloc.commons.text.ITextProvider;
import com.phloc.commons.text.impl.TextFormatter;

/**
 * Resolves texts either from an override, a text provider or otherwise uses a
 * fallback, based on the given enum constant.
 * 
 * @author Philip Helger
 */
@ThreadSafe
public abstract class AbstractEnumTextResolverWithOverrideAndFallback implements IEnumTextResolver
{
  private static final IStatisticsHandlerKeyedCounter s_aStatsGetText = StatisticsManager.getKeyedCounterHandler (AbstractEnumTextResolverWithOverrideAndFallback.class.getName () +
                                                                                                                  "$getText");
  private static final IStatisticsHandlerKeyedCounter s_aStatsGetTextWithArgs = StatisticsManager.getKeyedCounterHandler (AbstractEnumTextResolverWithOverrideAndFallback.class.getName () +
                                                                                                                          "$getTextWithArgs");
  private static final IStatisticsHandlerCounter s_aStatsOverride = StatisticsManager.getCounterHandler (AbstractEnumTextResolverWithOverrideAndFallback.class.getName () +
                                                                                                         "$OVERRIDE");
  private static final IStatisticsHandlerCounter s_aStatsFallback = StatisticsManager.getCounterHandler (AbstractEnumTextResolverWithOverrideAndFallback.class.getName () +
                                                                                                         "$FALLBACK");

  /**
   * This method must return the override string for the passed parameters.
   * 
   * @param sID
   *        Unique string ID
   * @param aContentLocale
   *        locale to use.
   * @return The string in the passed locale. May be null.
   */
  @Nullable
  protected abstract String internalGetOverrideString (@Nonnull String sID, @Nonnull Locale aContentLocale);

  /**
   * This method must return the fallback string for the passed parameters.
   * 
   * @param sID
   *        Unique string ID
   * @param aContentLocale
   *        locale to use.
   * @return The string in the passed locale. May be null.
   */
  @Nullable
  protected abstract String internalGetFallbackString (@Nonnull String sID, @Nonnull Locale aContentLocale);

  @Nullable
  private String _getText (@Nonnull final Enum  aEnum,
                           @Nonnull final ISimpleTextProvider aTP,
                           @Nonnull final Locale aContentLocale,
                           final boolean bIsWithArgs)
  {
    // Get the unique text element ID
    final String sID = EnumHelper.getEnumID (aEnum);
    // Increment the statistics
    (bIsWithArgs ? s_aStatsGetTextWithArgs : s_aStatsGetText).increment (sID);

    // Is there an override available?
    String ret = internalGetOverrideString (sID, aContentLocale);
    if (ret != null)
    {
      // An override string was found!
      s_aStatsOverride.increment ();
    }
    else
    {
      // No override was found
      // -> Try to get the text from the text provider
      ret = aTP.getTextWithLocaleFallback (aContentLocale);
      if (ret == null)
      {
        // The text was not found -> try the fallback (e.g. for different
        // locale)
        s_aStatsFallback.increment ();
        ret = internalGetFallbackString (sID, aContentLocale);
      }
    }
    return ret;
  }

  @Nullable
  public final String getText (@Nonnull final Enum  aEnum,
                               @Nonnull final ISimpleTextProvider aTP,
                               @Nonnull final Locale aContentLocale)
  {
    return _getText (aEnum, aTP, aContentLocale, false);
  }

  @Nullable
  public final String getTextWithArgs (@Nonnull final Enum  aEnum,
                                       @Nonnull final ITextProvider aTP,
                                       @Nonnull final Locale aContentLocale,
                                       @Nullable final Object... aArgs)
  {
    // The same as getText
    final String sText = _getText (aEnum, aTP, aContentLocale, true);
    // And if something was found, resolve the arguments
    return TextFormatter.getFormattedText (sText, aArgs);
  }
}