Create a new grid of passed-in size.

If a is set, and if it have the same size that the grid, it's used to fill the collection at creation.

If dV is set, all null elements in the grid will be replaced by dV value.

The add method is unsupported by the Grid class.

The addAll method is unsupported by the Grid class.

Copy the content of the passed-in grid at the specified coordinates. The passed-in grid is paste into this grid such the top-left coordinates will start at the specified Point argument.

See also

Removes all of the elements from this collection. This collection will not be empty after this method.

If a default value have been defined for the grid then all cells of the grid contains that value.

Returns true if this grid contains at least one occurence of the specified element. Moreformally, returns true if and only if this grid contains at least an element e such that o === e.

Returns true if this grid contains all of the elements of the specified collection. If the specified collection is also a Grid, this method returns true if it is a subliset of this queue.

If the passed-in Collection is null the method throw a NullPointerException error.

If the passed-in Collection type is different than the current one the function will throw an IllegalArgumentException. However, if the type of this grid is null, the passed-in Collection can have any type.

The rules which govern collaboration between typed and untyped Collection are described in the isValidCollection descrition, all rules described there are supported by the containsAll method.

See also

Fill the current grid with the passed-in value.

If the passed-in value is a "real" object (not a primitive) then all cells contains a reference to the same object.

Returns a Point witch is the corresponding position of the passed-in value.

Returns the current default value of this grid used to replace value when removing an element.

Returns the size of the grid as Dimension.

The returned Dimension is a clone of the internal one.

Return the current type allowed in the Grid

Returns the element stored at the passed-in coordinate of the grid.

Creates the internal two dimensional array used to store data of the grid.

A Grid object is considered as empty if and only if all its cells contains null or the default value for the current Grid.

Check if a Point object is a valid coordinate in the current grid.

Returns true if this grid perform a verification of the type of elements.

Verify that the passed-in Collection is a valid collection for use with the addAll, removeAll, retainAll and containsAll methods.

When dealing with typed and untyped collection, the following rules apply :

• Two typed collection, which have the same type, can collaborate each other.
• Two untyped collection can collaborate each other.
• An untyped collection can add, remove, retain or contains any typed collection of any type without throwing errors.
• A typed collection will always fail when attempting to add, remove, retain or contains an untyped collection.

If the passed-in Collection is null the method throw a NullPointerException error.

See also

Verify that the passed-in object type match the current Grid element's type.

In the case that the grid is untyped the function will always returns true.

In the case that the object's type prevents it to be added as element for this grid the method will throw a ClassCastException.

Returns an iterator over the elements in this collection. Iterations are performed in the following order : columns first, rows after.

Result for a 2x2 grid :

• Cell 0, 0
• Cell 1, 0
• Cell 0, 1
• Cell 1, 1

Verify if the passed-in object can be inserted in the current Grid.

Removes a single instance of the specified element from this grid, if this grid contains one or more such elements. Returns true if this grid contained the specified element (or equivalently, if this collection changed as a result of the call).

In order to remove all occurences of an element you have to call the remove method as long as the grid contains an occurrence of the passed-in element. Typically, the construct to remove all occurrences of an element should look like that :

      while( grid.contains( element ) ) grid.remove( element );
      

If the current grid object is typed and if the passed-in object's type prevents it to be added (and then removed) in this grid, the function throws a ClassCastException.

The Grid introduce a specific behavior for its default value, if the passed-in element is the default value for this grid the function return null and isnt't modified as result of the call.

Removes from this grid all of its elements that are contained in the specified collection (optional operation). At the end of the call there's no occurences of any elements contained in the passed-in collection.

The only values which cannot be removed by a call to removeAll is the default value for this grid. It result that all cells which contained a value also contained in the passed-in collection are filled with the grid's default value.

The rules which govern collaboration between typed and untyped Collection are described in the isValidCollection descrition, all rules described there are supported by the removeAll method.

See also

Removes the content of the passed-in grid at the specified coordinates. The passed-in grid is removed from this grid such the top-left coordinates will start at the specified Point argument.

The content of the passed-in grid is only removed in the bounds of the grid in this grid space coordinates. Values which are also stored in the passed-in grid but whose coordinates aren't in the bounds of the operation aren't remove.

See also

Removes the value located at the passed-in coordinate.

If the grid changed after the call the function returns true. If the passed-in Point isn't a valid coordinate for this grid the function failed and return false.

If a default value is set, the cell contains that value instead of null after the call.

Retains only the elements in this queue that are contained in the specified collection (optional operation). In other words, removes from this queue all of its elements that are not contained in the specified collection.

The only values which cannot be removed by a call to retainAll is the default value for this grid. It result that all cells which contained a value that are not contained in the passed-in collection are filled with the grid's default value.

The rules which govern collaboration between typed and untyped Collection are described in the isValidCollection descrition, all rules described there are supported by the retainAll method.

See also

Fill the content with an array of witch length is equal to the grid size().

The call return true only if the Grid changed as results of the call.

Defines the default value for this grid's cells content. When changing the default value of a grid, the cells which previously contains the old default value will contains the new one at the end of the call.

Defines value of grid cell defining by passed-in Point coordinate.

The call return true only if the Grid changed as results of the call.

Returns the number of elements this collection can contains.

Returns an array containing all the elements in this grid. Obeys the general contract of the Collection.toArray method.

See also

Returns the String representation of this object.

The function return a string like com.bourre.structures::Grid<String> for a typed collection. The string between the < and > is the name of the type of the collection's elements. If the collection is an untyped collection the function will simply return the result of the PixlibStringifier.stringify call.