com.google.gwt.coreext.client.JsIntegerMap.java Source code

Introduction

Here is the source code for com.google.gwt.coreext.client.JsIntegerMap.java

Source

/*
 * Copyright 2008 Google Inc.
 * 
 * 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.
 */
package com.google.gwt.coreext.client;

import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArrayNumber;

/**
 * Creates a lightweight map with integer keys based on a JavaScript object.
 * 
 * @param <T> the type contained as value in the map
 */
public class JsIntegerMap<T> extends JavaScriptObject {

    /**
     * Callback interface for int,double key value pairs.
     */
    public interface IterationCallBack<T> {
        void onIteration(int key, T val);
    }

    /**
     * Create a new empty map.
     * 
     * @param <T> the type of values to be stored in the map
     * @return an empty map
     */
    public static native <T> JsIntegerMap<T> create() /*-{
                                                      return {};
                                                      }-*/;

    protected JsIntegerMap() {
    }

    /**
     * Removes the mapping for this key from the map.
     * 
     * @param key
     */
    public final native void erase(int key) /*-{
                                            delete this[key];
                                            }-*/;

    /**
     * Returns the value associated with the specified key.
     * 
     * @param key
     * @return the value associated with the key
     */
    public final native T get(int key) /*-{
                                       return this[key];
                                       }-*/;

    /**
     * Returns an array containing all the values in this map.
     * 
     * @return a snapshot of the values contained in the map
     */
    public final native JsArrayNumber getKeys() /*-{
                                                var data = [];
                                                for (var prop in this) {
                                                var val = Number(prop);
                                                if (!isNaN(val)) {
                                                data.push(val);
                                                }
                                                }
                                                return data;
                                                }-*/;

    /**
     * Returns an array containing all the values in this map.
     * 
     * @return a snapshot of the values contained in the map
     */
    public final native JSOArray<T> getValues() /*-{
                                                var data = [];
                                                for (var i in this) {
                                                if (this.hasOwnProperty(i)) {
                                                data.push(this[i]);
                                                }
                                                }
                                                return data;
                                                }-*/;

    /**
     * Returns true if this map has an entry for the specified key.
     * 
     * @param key
     * @return true if this map has an entry for the given key
     */
    public final native boolean hasKey(int key) /*-{
                                                return this.hasOwnProperty(key);
                                                }-*/;

    /**
     * Iterates through the contents and calls back out to a callback.
     * 
     * @param cb callback object
     */
    public final native void iterate(IterationCallBack<T> cb) /*-{
                                                              for (var key in this) {
                                                              if (this.hasOwnProperty(key)) {
                                                              cb.@com.google.gwt.coreext.client.JsIntegerMap.IterationCallBack::onIteration(ILjava/lang/Object;)(parseInt(key),this[key]);
                                                              }
                                                              }
                                                              }-*/;

    /**
     * Associates the specified value with the specified key in this map.
     * 
     * @param key key with which the value will be associated
     * @param val value to be associated with key
     */
    public final native void put(int key, T val) /*-{
                                                 this[key] = val;
                                                 }-*/;
}