com.codepulsar.nils.adapter.rb.ResourceBundleAdapterConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nils-core Show documentation

The core NILS library - A Java NLS library (aka national language support, localisation, internationalisation, i18n, l10n).

The newest version!

package com.codepulsar.nils.adapter.rb;

import static com.codepulsar.nils.core.error.ErrorTypes.CONFIG_ERROR;
import static com.codepulsar.nils.core.util.ParameterCheck.nilsException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.codepulsar.nils.api.adapter.AdapterFactory;
import com.codepulsar.nils.core.adapter.config.BaseLocalizedResourceNilsConfig;
import com.codepulsar.nils.core.util.ParameterCheck;

/** Configuration for the {@link ResourceBundleAdapter} implementation. */
public class ResourceBundleAdapterConfig
    extends BaseLocalizedResourceNilsConfig {
  private static Logger LOG = LoggerFactory.getLogger(ResourceBundleAdapterConfig.class);

  private ResourceBundleAdapterConfig(Class owner) {
    super(owner, "properties");
  }

  @Override
  public Class> getFactoryClass() {
    return ResourceBundleAdapterFactory.class;
  }

  /**
   * {@inheritDoc}
   *
   * Note: always {@code true} for ResourceBundles.
   */
  @Override
  public boolean isFallbackActive() {
    return super.isFallbackActive();
  }

  /**
   * {@inheritDoc}
   *
   * 
Note: always {@code true} for ResourceBundles.
   */
  @Override
  public ResourceBundleAdapterConfig fallbackActive(boolean fallback) {
    LOG.warn("Call of fallbackActive() will be ignored for ResourceBundles.");
    return super.fallbackActive(true);
  }

  /**
   * Create a ResourceBundleAdapterConfig from a class as reference.
   *
   * 
Note: The {@code Class} will be used for resolving and accessing the translation
   * files. files.
   *
   * @param owner A Class
   * @return The created ResourceBundleAdapterConfig.
   */
  public static ResourceBundleAdapterConfig init(Class owner) {
    ParameterCheck.notNull(owner, "owner", nilsException(CONFIG_ERROR));
    return new ResourceBundleAdapterConfig(owner);
  }

  /**
   * Create a ResourceBundleAdapterConfig from an object as reference.
   *
   * Note: The object's class will be used for resolving and accessing the translation
   * files. files.
   *
   * @param owner An object
   * @return The created ResourceBundleAdapterConfig.
   */
  public static ResourceBundleAdapterConfig init(Object owner) {
    ParameterCheck.notNull(owner, "owner", nilsException(CONFIG_ERROR));
    return init(owner.getClass());
  }
}