com.gemstone.gemfire.cache.query.types.MapType 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;

/**
 * Represents the type of a Map, a collection that contains keys as well
 * as values and maintains an association between key-value pairs.
 * The type of the keys is obtained from the getKeyType method, and the type
 * of the values is obtained from the getElementType method.
 *
 * @since 4.0
 * @author Eric Zoerner
 */
public interface MapType extends CollectionType {
  
  /**
   * Return the type of the keys in this type of map.
   * @return the ObjectType of the keys in this type of map.
   */
  public ObjectType getKeyType();
  
  /** Return the type of the entries in this map.
   *  In the context of the query language, the entries in a map are
   *  structs with key and value fields.
   */
  public StructType getEntryType();
}