com.contentful.java.cda.LocalizedResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-sdk Show documentation
Java SDK for Contentful's Content Delivery API.
There is a newer version: 9.1.0
package com.contentful.java.cda;

import java.util.Map;

/**
 * Represents a resource which may contain field values for multiple locales.
 */
public abstract class LocalizedResource extends CDAResource {
  private static final long serialVersionUID = 5713028146014748949L;

  public class Localizer {
    private final String locale;

    Localizer(String locale) {
      this.locale = locale;
    }

    /**
     * Extracts a field from the fields set of the active locale, result type is inferred.
     *
     * @param key field key.
     * @param  type.
     * @return field value, null if it doesn't exist.
     */
    @SuppressWarnings("unchecked")
    public  T getField(String key) {
      final Map value = (Map) fields.get(key);
      if (value == null) {
        return null;
      }

      return getFieldForFallbackLocale(value, locale);
    }

     T getFieldForFallbackLocale(Map value, String locale) {
      if (locale == null) {
        return null;
      }

      final T localized = value.get(locale);
      if (localized != null) {
        return localized;
      } else {
        return getFieldForFallbackLocale(value, fallbackLocaleMap.get(locale));
      }
    }
  }

  String defaultLocale;

  Map fallbackLocaleMap;

  Map fields;

  Map rawFields;

  /**
   * Creates an object to be used for returning different field in one locale.
   *
   * @param locale pointing to a locale in the environment.
   * @return localizer to localize the fields.
   */
  public Localizer localize(String locale) {
    return new Localizer(locale);
  }

  /**
   * Get a field using the environments default locale.
   *
   * @param key field key.
   * @param  type.
   * @return field value, null if it doesn't exist.
   * @see #localize(String)
   */
  public  T getField(String key) {
    return localize(defaultLocale).getField(key);
  }

  /**
   * Extracts a field from the fields set of the active locale, result type is inferred.
   *
   * @param locale locale to be used.
   * @param key field key.
   * @param  type.
   * @return field value, null if it doesn't exist.
   */
  public  T getField(String locale, String key) {
    return localize(locale).getField(key);
  }

  /**
   * Internal method for updating contents of a field.
   * 
   * This method is used by the SDK to generate objects based on raw fields.
   *
   * Do not use this field to update data on Contentful. Take a look at the CMA-SDK for that.
   *
   * @param locale locale to be updated.
   * @param key    the key of the field to be updated.
   * @param value  the value of the field to be used.
   */
  @SuppressWarnings("unchecked")
  public void setField(String locale, String key, Object value) {
    ((Map) fields.get(key)).put(locale, value);
  }

  /**
   * @return raw unprocessed fields.
   */
  public Map rawFields() {
    return rawFields;
  }
}