net.rim.device.api.lbs.maps.model
Class MapPolyLine

java.lang.Object
  extended by net.rim.device.api.lbs.maps.model.AbstractMappable
      extended by net.rim.device.api.lbs.maps.model.MapPolyLine
All Implemented Interfaces:
Boxable, Mappable, Persistable
Direct Known Subclasses:
MapSimplePolygon, GsPolyLine

public class MapPolyLine
extends AbstractMappable
implements Persistable

Represents a continuous line that is composed of the line segments between an ordered set of MapPoint objects.

Since:
BlackBerry API 7.0.0

Constructor Summary
MapPolyLine()
          Constructs a new instance of MapPolyLine.
MapPolyLine(MapPoint[] points)
          Constructs a MapPolyLine with the specified ordered array of MapPoint objects.
 
Method Summary
 void addPoint(MapPoint point)
          Adds a point to the end of the MapPolyLine.
 boolean equals(Object obj)
          Indicates whether some other object is "equal to" this one.
 LatLonRectangle getBoundingBox()
          Retrieves the latitude and longitude-based bounding box of this mappable item.
 MapPoint getPoint(int index)
          Retrieves the MapPoint element at the given index.
 int hashCode()
          Returns a hash code value for the object.
 void insertPointAt(MapPoint point, int index)
          Inserts a point into the MapPolyLine at the specified index.
 void removeAllPoints()
          Removes all points from the MapPolyLine.
 boolean removePoint(MapPoint point)
          Removes the first instance of the given point.
 void removePointAt(int index)
          Removes the point at the given index.
 void setPointAt(MapPoint point, int index)
          Replaces the point at the given index with the given point.
 int size()
          Retrieves the number of points in this MapPolyLine.
 
Methods inherited from class net.rim.device.api.lbs.maps.model.AbstractMappable
getCommandsByType, getStyleId, isClusterable, match, setStyleId
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

MapPolyLine

public MapPolyLine()
Constructs a new instance of MapPolyLine.

Since:
BlackBerry API 7.0.0

MapPolyLine

public MapPolyLine(MapPoint[] points)
Constructs a MapPolyLine with the specified ordered array of MapPoint objects.

Parameters:
points - An ordered array of MapPoint objects.
Since:
BlackBerry API 7.0.0


Method Detail

getBoundingBox

public LatLonRectangle getBoundingBox()
Description copied from interface: Boxable
Retrieves the latitude and longitude-based bounding box of this mappable item.

Note: It's recommended that for classes that implement Boxable that the bounding box calculation be performed at request time, and not at modification time. When there are multiple modifications to perform, continuous recalculation of the bounding box is unnecessary.

It's also recommended that you cache the bounding box information once it's been calculated because requests for the bounding box may be frequent.

Specified by:
getBoundingBox in interface Boxable
Returns:
The axis-aligned bounding box or null if there is no bounding box.
Since:
BlackBerry API 7.0.0

getPoint

public MapPoint getPoint(int index)
Retrieves the MapPoint element at the given index.

Parameters:
index - The index.
Returns:
The map point at the specified index.
Throws:
ArrayIndexOutOfBoundsException - if the index is invalid.
Since:
BlackBerry API 7.0.0

addPoint

public void addPoint(MapPoint point)
Adds a point to the end of the MapPolyLine.

Parameters:
point - The point to add to the MapPolyLine.
Since:
BlackBerry API 7.0.0

insertPointAt

public void insertPointAt(MapPoint point,
                          int index)
Inserts a point into the MapPolyLine at the specified index.

Parameters:
point - The point to insert.
index - The index at which to insert the point.
Throws:
ArrayIndexOutOfBoundsException - if the index is invalid.
Since:
BlackBerry API 7.0.0

removeAllPoints

public void removeAllPoints()
Removes all points from the MapPolyLine.

Since:
BlackBerry API 7.0.0

removePoint

public boolean removePoint(MapPoint point)
Removes the first instance of the given point.

Parameters:
point - The point to remove.
Returns:
true if the point was a component of the MapPolyLine, false otherwise.
Since:
BlackBerry API 7.0.0

removePointAt

public void removePointAt(int index)
Removes the point at the given index.

Parameters:
index - The index of the point to remove.
Throws:
ArrayIndexOutOfBoundsException - if the index is invalid.
Since:
BlackBerry API 7.0.0

setPointAt

public void setPointAt(MapPoint point,
                       int index)
Replaces the point at the given index with the given point.

Parameters:
point - The new point.
index - The index of the point to replace.
Throws:
ArrayIndexOutOfBoundsException - if the index is invalid.
Since:
BlackBerry API 7.0.0

size

public int size()
Retrieves the number of points in this MapPolyLine.

Returns:
The number of points in this MapPolyLine.
Since:
BlackBerry API 7.0.0

hashCode

public int hashCode()
Description copied from class: Object
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Overrides:
hashCode in class AbstractMappable
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object), Hashtable
Since:
BlackBerry API 7.0.0

equals

public boolean equals(Object obj)
Description copied from class: Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:
equals in class AbstractMappable
Parameters:
obj - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Boolean.hashCode(), Hashtable
Since:
BlackBerry API 7.0.0





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal