org.geotools.geometry.iso.topograph2D
Class CoordinateList

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.ArrayList
              extended by org.geotools.geometry.iso.topograph2D.CoordinateList
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess

public class CoordinateList
extends java.util.ArrayList

A list of Coordinates, which may be set to prevent repeated coordinates from occuring in the list.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.AbstractList
modCount
 
Constructor Summary
CoordinateList()
          Constructs a new list without any coordinates
CoordinateList(Coordinate[] coord)
          The basic constructor for a CoordinateArray allows repeated points (i.e produces a CoordinateList with exactly the same set of points)
CoordinateList(Coordinate[] coord, boolean allowRepeated)
          Constructs a new list from an array of Coordinates, allowing caller to specify if repeated points are to be removed.
 
Method Summary
 boolean add(Coordinate[] coord, boolean allowRepeated)
          Add an array of coordinates
 boolean add(Coordinate[] coord, boolean allowRepeated, boolean direction)
          Add an array of coordinates
 void add(Coordinate coord, boolean allowRepeated)
          Add a coordinate
 boolean add(java.lang.Object obj, boolean allowRepeated)
          Add a coordinate
 boolean addAll(java.util.Collection coll, boolean allowRepeated)
          Add an array of coordinates
 java.lang.Object clone()
          Returns a deep copy of this CoordinateList instance.
 void closeRing()
          Ensure this coordList is a ring, by adding the start point if necessary
 Coordinate getCoordinate(int i)
           
 Coordinate[] toCoordinateArray()
          Returns the Coordinates in this collection.
 
Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode
 
Methods inherited from class java.util.AbstractCollection
containsAll, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
containsAll, equals, hashCode
 

Constructor Detail

CoordinateList

public CoordinateList()
Constructs a new list without any coordinates


CoordinateList

public CoordinateList(Coordinate[] coord)
The basic constructor for a CoordinateArray allows repeated points (i.e produces a CoordinateList with exactly the same set of points)

Parameters:
coord - the initial coordinates

CoordinateList

public CoordinateList(Coordinate[] coord,
                      boolean allowRepeated)
Constructs a new list from an array of Coordinates, allowing caller to specify if repeated points are to be removed.

Parameters:
coord - the array of coordinates to load into the list
allowRepeated - if false, repeated points are removed
Method Detail

getCoordinate

public Coordinate getCoordinate(int i)

add

public boolean add(Coordinate[] coord,
                   boolean allowRepeated,
                   boolean direction)
Add an array of coordinates

Parameters:
coord - The coordinates
allowRepeated - if set to false, repeated coordinates are collapsed
direction - if false, the array is added in reverse order
Returns:
true (as by general collection contract)

add

public boolean add(Coordinate[] coord,
                   boolean allowRepeated)
Add an array of coordinates

Parameters:
coord - The coordinates
allowRepeated - if set to false, repeated coordinates are collapsed
Returns:
true (as by general collection contract)

add

public boolean add(java.lang.Object obj,
                   boolean allowRepeated)
Add a coordinate

Parameters:
obj - The coordinate to add
allowRepeated - if set to false, repeated coordinates are collapsed
Returns:
true (as by general collection contract)

add

public void add(Coordinate coord,
                boolean allowRepeated)
Add a coordinate

Parameters:
coord - The coordinates
allowRepeated - if set to false, repeated coordinates are collapsed

addAll

public boolean addAll(java.util.Collection coll,
                      boolean allowRepeated)
Add an array of coordinates

Parameters:
coll - The coordinates
allowRepeated - if set to false, repeated coordinates are collapsed
Returns:
true (as by general collection contract)

closeRing

public void closeRing()
Ensure this coordList is a ring, by adding the start point if necessary


toCoordinateArray

public Coordinate[] toCoordinateArray()
Returns the Coordinates in this collection.

Returns:
the coordinates

clone

public java.lang.Object clone()
Returns a deep copy of this CoordinateList instance.

Overrides:
clone in class java.util.ArrayList
Returns:
a clone of this CoordinateList instance


Copyright © 1996-2010 Geotools. All Rights Reserved.