elemental.html.Uint8Array Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 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 elemental.html;

import elemental.events.*;
import elemental.util.*;
import elemental.dom.*;
import elemental.html.*;
import elemental.css.*;
import elemental.stylesheets.*;

import java.util.Date;

/**
  * The UInt8Array type represents an array of 8-bit unsigned integers.
Once established, you can reference elements in the array using the object's methods, or using standard array index syntax (that is, using bracket notation).
  */
public interface Uint8Array extends ArrayBufferView, IndexableInt {

  /**
    * The size, in bytes, of each array element.
    */

    static final int BYTES_PER_ELEMENT = 1;


  /**
    * The number of entries in the array; for these 8-bit values, this is the same as the size of the array in bytes. Read only.
    */
  int getLength();

  void setElements(Object array);

  void setElements(Object array, int offset);


  /**
    * Returns a new Uint8Array view on the ArrayBuffer store for this Uint8Array object.

Parameters
 begin
 The offset to the first element in the array to be referenced by the new Uint8Array object.
 end 
Optional
 The offset to the element after last element in the array to be referenced by the new Uint8Array object; if not specified, all elements from the one specified by begin to the end of the array are included in the new view.

Notes
The range specified by begin and end is clamped to the valid index range for the current array; if the computed length of the new array would be negative, it's clamped to zero. If either begin or end is negative, it refers to an index from the end of the array instead of from the beginning.
Note: Keep in mind that this is creating a new view on the existing buffer; changes to the new object's contents will impact the original object and vice versa.
    */
  Uint8Array subarray(int start);


  /**
    * Returns a new Uint8Array view on the ArrayBuffer store for this Uint8Array object.

Parameters
 begin
 The offset to the first element in the array to be referenced by the new Uint8Array object.
 end 
Optional
 The offset to the element after last element in the array to be referenced by the new Uint8Array object; if not specified, all elements from the one specified by begin to the end of the array are included in the new view.

Notes
The range specified by begin and end is clamped to the valid index range for the current array; if the computed length of the new array would be negative, it's clamped to zero. If either begin or end is negative, it refers to an index from the end of the array instead of from the beginning.
Note: Keep in mind that this is creating a new view on the existing buffer; changes to the new object's contents will impact the original object and vice versa.
    */
  Uint8Array subarray(int start, int end);
}