com.google.gwt.core.client.JsArrayInteger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-mock-2.5.1 Show documentation
A mocked implementation for GWT-2.5.1 that can run in the JVM to allow integration testing
The newest version!
/*
 * 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.core.client;

import com.google.common.base.Joiner;

/**
 * A simple wrapper around a homogeneous native array of integer values.
 * 
 * This class may not be directly instantiated, and can only be returned from a
 * native method. For example,
 * 
 * 
 * native JsArrayInteger getNativeArray() /*-{
 *   return [1, 2, 3];
 * }-* /;
 * 
 */
public class JsArrayInteger extends JsArrayBase {

  public JsArrayInteger() {
  }

  /**
   * Gets the value at a given index.
   * 
   * If no value exists at the given index, a type-conversion error will occur
   * in Development Mode and unpredictable behavior may occur in Production
   * Mode. If the numeric value returned is non-integral, it will cause a
   * warning in Development Mode, and may affect the results of mathematical
   * expressions.
   *
   * @param index the index to be retrieved
   * @return the value at the given index
   */
  public final int get(int index) {
	  return list.get(index);
  }

  /**
   * Convert each element of the array to a String and join them with a comma
   * separator. The value returned from this method may vary between browsers
   * based on how JavaScript values are converted into strings.
   */
  public final String join() {
    // As per JS spec
    return join(",");
  }

  /**
   * Convert each element of the array to a String and join them with a comma
   * separator. The value returned from this method may vary between browsers
   * based on how JavaScript values are converted into strings.
   */
  public final String join(String separator) {
	  return Joiner.on(separator).join(list);
  }

  /**
   * Gets the length of the array.
   * 
   * @return the array length
   */
  public final int length() {
	  return list.size();
  }

  /**
   * Pushes the given integer onto the end of the array.
   */
  public final void push(int value) {
	  list.add(value);
  }
  
  /**
   * Sets the value value at a given index.
   * 
   * If the index is out of bounds, the value will still be set. The array's
   * length will be updated to encompass the bounds implied by the added value.
   * 
   * @param index the index to be set
   * @param value the value to be stored
   */
  public final void set(int index, int value) {
	  list.add(index, value);
  }

  /**
   * Reset the length of the array.
   * 
   * @param newLength the new length of the array
   */
  public final void setLength(int newLength) {
	  // do nothing
  }

  /**
   * Shifts the first value off the array.
   * 
   * @return the shifted value
   */
  public final native int shift() /*-{
    return this.shift();
  }-*/;

  /**
   * Shifts a value onto the beginning of the array.
   * 
   * @param value the value to the stored
   */
  public final native void unshift(int value) /*-{
    this.unshift(value);
  }-*/;
  
}