org.geotools.coverage.grid

Class GeneralGridCoordinates.Immutable

Object

GeneralGridCoordinates

GeneralGridCoordinates.Immutable

All Implemented Interfaces:

Serializable, Cloneable, GridCoordinates

Enclosing class:

GeneralGridCoordinates

public static final class GeneralGridCoordinates.Immutable
extends GeneralGridCoordinates

An immutable GridCoordinates. This is sometime useful for creating a single instance to be shared by many objects without the cost of cloning. This class is final in order to prevent subclasses from making it mutable again.

Since:

2.5

Author:

Martin Desruisseaux

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class GeneralGridCoordinates

GeneralGridCoordinates.Immutable

Constructor Summary

Constructors

Constructor and Description
Immutable(GridCoordinates coordinates) Creates an immutable grid coordinates with the specified values.
Immutable(int[] coordinates) Creates an immutable grid coordinates with the specified values.
Immutable(int[] coordinates, int lower, int upper) Creates an immutable grid coordinates with the specified values in the specified range.

Method Summary

Modifier and Type	Method and Description
GeneralGridCoordinates	clone() Returns a mutable clone of this grid coordinates.
void	setCoordinateValue(int dimension, int value) Do not allows modification of this grid coordinates.

Methods inherited from class GeneralGridCoordinates

equals, getCoordinateValue, getCoordinateValues, getDimension, hashCode, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Immutable

public Immutable(int[] coordinates)

Creates an immutable grid coordinates with the specified values.

Parameters:

coordinates - The grid coordinates to copy.

Immutable

public Immutable(int[] coordinates,
                 int lower,
                 int upper)

Creates an immutable grid coordinates with the specified values in the specified range.

Parameters:

coordinates - The coordinates to copy.

lower - Index of the first value to copy, inclusive.

upper - Index of the last value to copy, exclusive.

Immutable

public Immutable(GridCoordinates coordinates)

Creates an immutable grid coordinates with the specified values.

Parameters:

coordinates - The grid coordinates to copy.

Method Detail

setCoordinateValue

public void setCoordinateValue(int dimension,
                               int value)
                        throws UnsupportedOperationException

Do not allows modification of this grid coordinates.

Specified by:

setCoordinateValue in interface GridCoordinates

Overrides:

setCoordinateValue in class GeneralGridCoordinates

Parameters:

dimension - The index of the value to set.

value - The new value.

Throws:

UnsupportedOperationException - always thrown.

clone

public GeneralGridCoordinates clone()

Returns a mutable clone of this grid coordinates. The clone is an instance of GeneralGridCoordinates rather than this Immutable subclass.

Overrides:

clone in class GeneralGridCoordinates

Returns:

A mutable clone of this grid coordinates.

See Also:

Object.clone()