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

java.lang.Object
  extended by net.rim.device.api.lbs.maps.model.AbstractMappable
      extended by net.rim.device.api.lbs.maps.model.MapPoint
          extended by net.rim.device.api.lbs.maps.model.PeerPoint
All Implemented Interfaces:
Comparable, Boxable, Mappable, Persistable

public class PeerPoint
extends MapPoint
implements Persistable

Represents a static location, with accuracy. For example, you can use a PeerPoint to indicate the BlackBerry device user's last location.

Since:
BlackBerry API 7.0.0

Constructor Summary
PeerPoint()
          Constructs a new PeerPoint instance.
PeerPoint(double lat, double lon)
          Constructs a PeerPoint instance at the given coordinates.
 
Method Summary
 boolean equals(Object obj)
          Indicates whether some other object is "equal to" this one.
 int getAccuracy()
          Retrieves the accuracy (in meters) of this point.
 int getCourse()
          Retrieves the bearing of this PeerPoint.
 String getName()
          Retrieves the name of this PeerPoint.
 int hashCode()
          Returns a hash code value for the object.
 boolean isValid()
          Indicates whether the PeerPoint has valid data.
 void setAccuracy(int accuracy)
          Sets the accuracy (in meters) of this point.
 void setCourse(int course)
          Sets the bearing of this PeerPoint.
 void setName(String name)
          Sets the name of this PeerPoint.
protected  LatLonRectangle updateBoundingBox()
          Updates the bounding box.
 
Methods inherited from class net.rim.device.api.lbs.maps.model.MapPoint
compareTo, getBoundingBox, getLat, getLon, setLat, setLon, toCoordinates, toString
 
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, wait, wait, wait
 



Constructor Detail

PeerPoint

public PeerPoint()
Constructs a new PeerPoint instance.

Since:
BlackBerry API 7.0.0

PeerPoint

public PeerPoint(double lat,
                 double lon)
Constructs a PeerPoint instance at the given coordinates.

Parameters:
lat - The latitude coordinate.
lon - The longitude coordinate.
Since:
BlackBerry API 7.0.0


Method Detail

getAccuracy

public int getAccuracy()
Retrieves the accuracy (in meters) of this point.

Returns:
The accuracy (in meters) for this point.
Since:
BlackBerry API 7.0.0

setAccuracy

public void setAccuracy(int accuracy)
Sets the accuracy (in meters) of this point.

Parameters:
accuracy - The accuracy (in meters) for this point.
Since:
BlackBerry API 7.0.0

getName

public String getName()
Retrieves the name of this PeerPoint.

Returns:
The name for this point.
Since:
BlackBerry API 7.0.0

setName

public void setName(String name)
Sets the name of this PeerPoint.

Parameters:
name - The name for this point.
Since:
BlackBerry API 7.0.0

getCourse

public int getCourse()
Retrieves the bearing of this PeerPoint.

Returns:
The bearing for this PeerPoint (in degrees from 0 359). Negative values indicate that no bearing is available.
Since:
BlackBerry API 7.0.0

setCourse

public void setCourse(int course)
Sets the bearing of this PeerPoint.

Parameters:
course - The bearing for this PeerPoint (in degrees from 0 359). Negative values indicate that no bearing is available.
Since:
BlackBerry API 7.0.0

isValid

public boolean isValid()
Indicates whether the PeerPoint has valid data.

Returns:
true if the data is valid, false otherwise.
Since:
BlackBerry API 7.0.0

updateBoundingBox

protected LatLonRectangle updateBoundingBox()
Description copied from class: MapPoint
Updates the bounding box.

Overrides:
updateBoundingBox in class MapPoint
Returns:
the new bounding box.
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 MapPoint
Returns:
a hash code value for this object.
See Also:
Object.hashCode()
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 MapPoint
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:
Object.equals(Object)
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