com.rt.storage.api.client.util.GenericData Maven / Gradle / Ivy

Go to download
package com.rt.storage.api.client.util;

import java.util.AbstractMap;
import java.util.AbstractSet;
import java.util.EnumSet;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.ConcurrentMap;

/**
 * Generic data that stores all unknown data key name/value pairs.
 *
 * Subclasses can declare fields for known data keys using the {@link Key} annotation. Each field
 * can be of any visibility (private, package private, protected, or public) and must not be static.
 * {@code null} unknown data key names are not allowed, but {@code null} data values are allowed.
 *
 * 
Iteration order of the data keys is based on the sorted (ascending) key names of the declared
 * fields, followed by the iteration order of all of the unknown data key name/value pairs.
 *
 * 
Implementation is not thread-safe. For a thread-safe choice instead use an implementation of
 * {@link ConcurrentMap}.
 *
 * @since 1.0
 * @author Yaniv Inbar
 */
public class GenericData extends AbstractMap implements Cloneable {

  /** Map of unknown fields. */
  Map unknownFields = ArrayMap.create();

  // TODO(yanivi): implement more methods for faster implementation

  /** Class information. */
  final ClassInfo classInfo;

  /** Constructs with case-insensitive keys. */
  public GenericData() {
    this(EnumSet.noneOf(Flags.class));
  }

  /**
   * Flags that impact behavior of generic data.
   *
   * @since 1.10
   */
  public enum Flags {

    /** Whether keys are case sensitive. */
    IGNORE_CASE
  }

  /**
   * @param flags flags that impact behavior of generic data
   * @since 1.10
   */
  public GenericData(EnumSet flags) {
    classInfo = ClassInfo.of(getClass(), flags.contains(Flags.IGNORE_CASE));
  }

  @Override
  public final Object get(Object name) {
    if (!(name instanceof String)) {
      return null;
    }
    String fieldName = (String) name;
    FieldInfo fieldInfo = classInfo.getFieldInfo(fieldName);
    if (fieldInfo != null) {
      return fieldInfo.getValue(this);
    }
    if (classInfo.getIgnoreCase()) {
      fieldName = fieldName.toLowerCase(Locale.US);
    }
    return unknownFields.get(fieldName);
  }

  @Override
  public final Object put(String fieldName, Object value) {
    FieldInfo fieldInfo = classInfo.getFieldInfo(fieldName);
    if (fieldInfo != null) {
      Object oldValue = fieldInfo.getValue(this);
      fieldInfo.setValue(this, value);
      return oldValue;
    }
    if (classInfo.getIgnoreCase()) {
      fieldName = fieldName.toLowerCase(Locale.US);
    }
    return unknownFields.put(fieldName, value);
  }

  /**
   * Sets the given field value (may be {@code null}) for the given field name. Any existing value
   * for the field will be overwritten. It may be more slightly more efficient than {@link
   * #put(String, Object)} because it avoids accessing the field's original value.
   *
   * Overriding is only supported for the purpose of calling the super implementation and
   * changing the return type, but nothing else.
   */
  public GenericData set(String fieldName, Object value) {
    FieldInfo fieldInfo = classInfo.getFieldInfo(fieldName);
    if (fieldInfo != null) {
      fieldInfo.setValue(this, value);
    } else {
      if (classInfo.getIgnoreCase()) {
        fieldName = fieldName.toLowerCase(Locale.US);
      }
      unknownFields.put(fieldName, value);
    }
    return this;
  }

  @Override
  public final void putAll(Map map) {
    for (Map.Entry entry : map.entrySet()) {
      set(entry.getKey(), entry.getValue());
    }
  }

  @Override
  public final Object remove(Object name) {
    if (!(name instanceof String)) {
      return null;
    }
    String fieldName = (String) name;
    FieldInfo fieldInfo = classInfo.getFieldInfo(fieldName);
    if (fieldInfo != null) {
      throw new UnsupportedOperationException();
    }
    if (classInfo.getIgnoreCase()) {
      fieldName = fieldName.toLowerCase(Locale.US);
    }
    return unknownFields.remove(fieldName);
  }

  @Override
  public Set> entrySet() {
    return new EntrySet();
  }

  /**
   * Makes a "deep" clone of the generic data, in which the clone is completely independent of the
   * original.
   */
  @Override
  public GenericData clone() {
    try {
      @SuppressWarnings("unchecked")
      GenericData result = (GenericData) super.clone();
      Data.deepCopy(this, result);
      result.unknownFields = Data.clone(unknownFields);
      return result;
    } catch (CloneNotSupportedException e) {
      throw new IllegalStateException(e);
    }
  }

  /**
   * Returns the map of unknown data key name to value.
   *
   * @since 1.5
   */
  public final Map getUnknownKeys() {
    return unknownFields;
  }

  /**
   * Sets the map of unknown data key name to value.
   *
   * @since 1.5
   */
  public final void setUnknownKeys(Map unknownFields) {
    this.unknownFields = unknownFields;
  }

  @Override
  public boolean equals(Object o) {
    if (o == this) {
      return true;
    }
    if (o == null || !(o instanceof GenericData)) {
      return false;
    }
    GenericData that = (GenericData) o;
    return super.equals(that) && Objects.equals(this.classInfo, that.classInfo);
  }

  @Override
  public int hashCode() {
    return Objects.hash(super.hashCode(), classInfo);
  }

  @Override
  public String toString() {
    return "GenericData{" + "classInfo=" + classInfo.names + ", " + super.toString() + "}";
  }

  /**
   * Returns the class information.
   *
   * @since 1.10
   */
  public final ClassInfo getClassInfo() {
    return classInfo;
  }

  /** Set of object data key/value map entries. */
  final class EntrySet extends AbstractSet> {

    private final DataMap.EntrySet dataEntrySet;

    EntrySet() {
      dataEntrySet = new DataMap(GenericData.this, classInfo.getIgnoreCase()).entrySet();
    }

    @Override
    public Iterator> iterator() {
      return new EntryIterator(dataEntrySet);
    }

    @Override
    public int size() {
      return unknownFields.size() + dataEntrySet.size();
    }

    @Override
    public void clear() {
      unknownFields.clear();
      dataEntrySet.clear();
    }
  }

  /**
   * Iterator over the object data key/value map entries which iterates first over the fields and
   * then over the unknown keys.
   */
  final class EntryIterator implements Iterator> {

    /** Whether we've started iterating over the unknown keys. */
    private boolean startedUnknown;

    /** Iterator over the fields. */
    private final Iterator> fieldIterator;

    /** Iterator over the unknown keys. */
    private final Iterator> unknownIterator;

    EntryIterator(DataMap.EntrySet dataEntrySet) {
      fieldIterator = dataEntrySet.iterator();
      unknownIterator = unknownFields.entrySet().iterator();
    }

    public boolean hasNext() {
      return fieldIterator.hasNext() || unknownIterator.hasNext();
    }

    public Map.Entry next() {
      if (!startedUnknown) {
        if (fieldIterator.hasNext()) {
          return fieldIterator.next();
        }
        startedUnknown = true;
      }
      return unknownIterator.next();
    }

    public void remove() {
      if (startedUnknown) {
        unknownIterator.remove();
      }
      fieldIterator.remove();
    }
  }
}