com.gemstone.gemfire.cache.query.types.ObjectType Maven / Gradle / Ivy

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

SnappyData store based off Pivotal GemFireXD

The newest version!

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * 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. See accompanying
 * LICENSE file.
 */

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

import com.gemstone.gemfire.DataSerializable;

/**
 * An ObjectType represents the type of an object in a query.
 * An ObjectType is similar to a Class, except unlike a Class it can be
 * extended to add more information such as a subtype for collection Classes,
 * a key type for a map class, or a field information for structs.
 *
 * Note that multiple instances of are allowed of the same type, so ObjectTypes
 * should always be compared using equals.
 *
 * @see StructType
 * @see CollectionType
 * @see MapType
 *
 * @since 4.0
 * @author Eric Zoerner
 */
public interface ObjectType extends DataSerializable {

  /**
   * Return true if this is a CollectionType. Note that MapTypes, Region types,
   * and array types are also considered CollectionTypes in the context of the
   * query language and therefore return true to this method.
   */
  public boolean isCollectionType();
  
  /** Return true if this is a MapType */
  public boolean isMapType();
  
  /** Return true if this is a StructType */
  public boolean isStructType();
  
  /** @return the simple name for the class this resolves to without including
    * the package */
  public String getSimpleClassName();
  
  /** @return the Class that this type corresponds to.
   */
  public Class resolveClass();
}