com.phloc.commons.text.resolve.DefaultTextResolver 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 java.util.Set;

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

import com.phloc.commons.annotations.PresentForCodeCoverage;
import com.phloc.commons.annotations.ReturnsMutableCopy;
import com.phloc.commons.text.ITextProvider;

/**
 * Resolves texts either from a text provider or otherwise uses a fallback to a
 * file, based on the given enum constant.
 * 
 * @author Philip Helger
 */
@Immutable
public final class DefaultTextResolver
{
  private static final EnumTextResolverWithPropertiesOverrideAndFallback s_aResolver = new EnumTextResolverWithPropertiesOverrideAndFallback ();

  @PresentForCodeCoverage
  @SuppressWarnings ("unused")
  private static final DefaultTextResolver s_aInstance = new DefaultTextResolver ();

  private DefaultTextResolver ()
  {}

  public static boolean isUseResourceBundleCache ()
  {
    return s_aResolver.isUseResourceBundleCache ();
  }

  public static void setUseResourceBundleCache (final boolean bUseResourceBundleCache)
  {
    s_aResolver.setUseResourceBundleCache (bUseResourceBundleCache);
  }

  /**
   * Get the text of the given element in the given locale.
   * 
   * @param aEnum
   *        The enum element required for ID resolution
   * @param aTP
   *        The text provider holding the static texts
   * @param aContentLocale
   *        The locale to be used for resolving
   * @return The text or null if the text could not be resolved.
   */
  @Nullable
  public static String getText (@Nonnull final Enum  aEnum,
                                @Nonnull final ITextProvider aTP,
                                @Nonnull final Locale aContentLocale)
  {
    return s_aResolver.getText (aEnum, aTP, aContentLocale);
  }

  /**
   * Get the text of the given element in the given locale using the passed
   * arguments.
   * 
   * @param aEnum
   *        The enum element required for ID resolution
   * @param aTP
   *        The text provider holding the static texts
   * @param aContentLocale
   *        The locale to be used for resolving
   * @param aArgs
   *        The arguments to be inserted into the string, may be
   *        null
   * @return The text with the arguments replaced or null if the
   *         passed text could not be resolved.
   */
  @Nullable
  public static String getTextWithArgs (@Nonnull final Enum  aEnum,
                                        @Nonnull final ITextProvider aTP,
                                        @Nonnull final Locale aContentLocale,
                                        @Nullable final Object [] aArgs)
  {
    return s_aResolver.getTextWithArgs (aEnum, aTP, aContentLocale, aArgs);
  }

  @Nonnull
  @ReturnsMutableCopy
  public static Set  getAllUsedOverrideBundleNames ()
  {
    return s_aResolver.getAllUsedOverrideBundleNames ();
  }

  @Nonnull
  @ReturnsMutableCopy
  public static Set  getAllUsedFallbackBundleNames ()
  {
    return s_aResolver.getAllUsedFallbackBundleNames ();
  }

  public static void clearCache ()
  {
    s_aResolver.clearCache ();
  }
}