gemfire-core/src/main/java/com/gemstone/gemfire/cache/query/internal/types/CollectionTypeImpl.java

/*=========================================================================
 * Copyright (c) 2005-2014 Pivotal Software, Inc. All Rights Reserved.
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * more patents listed at http://www.pivotal.io/patents.
 *========================================================================
 */

package com.gemstone.gemfire.cache.query.internal.types;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.util.*;

import com.gemstone.gemfire.DataSerializer;
import com.gemstone.gemfire.cache.Region;
import com.gemstone.gemfire.cache.query.internal.NWayMergeResults;
import com.gemstone.gemfire.cache.query.internal.Ordered;
import com.gemstone.gemfire.cache.query.internal.ResultsSet;
import com.gemstone.gemfire.cache.query.internal.SortedResultSet;
import com.gemstone.gemfire.cache.query.internal.SortedStructSet;
import com.gemstone.gemfire.cache.query.internal.StructSet;
import com.gemstone.gemfire.cache.query.types.*;

/**
 * Implementation of CollectionType
 * @author Eric Zoerner
 * @since 4.0
 */
public class CollectionTypeImpl extends ObjectTypeImpl implements CollectionType {
  private static final long serialVersionUID = 892402666471396897L;
  private ObjectType elementType;
  /**
   * Empty constructor to satisfy <code>DataSerializer</code> requirements
   */
  public CollectionTypeImpl() {
  }
  
  /** Creates a new instance of ObjectTypeImpl */
  public CollectionTypeImpl(Class clazz, ObjectType elementType) {
    super(clazz);
    this.elementType = elementType;
  }
  
  public CollectionTypeImpl(String className, ObjectType elementType)
  throws ClassNotFoundException {
    super(className);
    this.elementType = elementType;
  }
  
  @Override
  public boolean equals(Object obj) {
    return super.equals(obj) &&
            (obj instanceof CollectionTypeImpl) &&
            this.elementType.equals(((CollectionTypeImpl)obj).elementType);
  }
  
  @Override
  public int hashCode() {
    return super.hashCode() ^ this.elementType.hashCode();
  }
  
  @Override
  public String toString(){
    return resolveClass().getName() +
            "<" + this.elementType.resolveClass().getName() + ">";
  }
  
  public boolean allowsDuplicates() {
    Class cls = resolveClass();
    return !Set.class.isAssignableFrom(cls) &&
            !Map.class.isAssignableFrom(cls) &&
            !Region.class.isAssignableFrom(cls) &&
            ! StructSet.class.isAssignableFrom(cls) &&
            ! SortedStructSet.class.isAssignableFrom(cls) &&
            ! SortedResultSet.class.isAssignableFrom(cls) &&
            ! ResultsSet.class.isAssignableFrom(cls) 
            ;
  }
  
  public ObjectType getElementType() {
    return this.elementType;
  }
  
  public boolean isOrdered() {
    Class cls = resolveClass();
    return List.class.isAssignableFrom(cls) || cls.isArray()           
            || Ordered.class.isAssignableFrom(cls) || TreeSet.class.isAssignableFrom(cls)
            || TreeMap.class.isAssignableFrom(cls) || LinkedHashSet.class.isAssignableFrom(cls)
            || LinkedHashMap.class.isAssignableFrom(cls);
  }

  @Override
  public boolean isCollectionType() { return true; }
  @Override
  public boolean isMapType() { return false; }
  @Override
  public boolean isStructType() { return false; }
  
  @Override
  public int getDSFID() {
    return COLLECTION_TYPE_IMPL;
  }

  @Override
  public void fromData(DataInput in) throws IOException, ClassNotFoundException {
    super.fromData(in);
    this.elementType = (ObjectType)DataSerializer.readObject(in);
  }

  @Override
  public void toData(DataOutput out) throws IOException {
     super.toData(out);
    DataSerializer.writeObject(this.elementType, out);
  }
}