javax.microedition.location
Class Landmark

java.lang.Object
  extended by javax.microedition.location.Landmark

public class Landmark
extends Object

The Landmark class represents a landmark, i.e. a known location with a name. A landmark has a name by which it is known to the end user, a textual description, QualifiedCoordinates and optionally AddressInfo.

This class is only a container for the information. The constructor does not validate the parameters passed in but just stores the values, except the name field is never allowed to be null. The get* methods return the values passed in the constructor. When the platform implementation returns Landmark objects, it MUST ensure that it only returns objects where the parameters have values set as described for their semantics in this class.

Since:
BlackBerry API 4.0.2

Constructor Summary
Landmark(String name, String description, QualifiedCoordinates coordinates, AddressInfo addressInfo)
          Constructs a new Landmark object with the values specified.
 
Method Summary
 AddressInfo getAddressInfo()
          Gets the AddressInfo of the landmark.
 String getDescription()
          Gets the landmark description.
 String getName()
          Gets the landmark name.
 QualifiedCoordinates getQualifiedCoordinates()
          Gets the QualifiedCoordinates of the landmark.
 void setAddressInfo(AddressInfo addressInfo)
          Sets the AddressInfo of the landmark.
 void setDescription(String description)
          Sets the description of the landmark.
 void setName(String name)
          Sets the name of the landmark.
 void setQualifiedCoordinates(QualifiedCoordinates cooordinates)
          Sets the QualifiedCoordinates of the landmark.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

Landmark

public Landmark(String name,
                String description,
                QualifiedCoordinates coordinates,
                AddressInfo addressInfo)

Constructs a new Landmark object with the values specified.

Parameters:
name - the name of the landmark
description - description of the landmark. May be null if not available.
coordinates - the Coordinates of the landmark. May be null if not known.
addressInfo - the textual address information of the landmark. May be null if not known.
Throws:
NullPointerException - if the name is null
Since:
BlackBerry API 4.0.2


Method Detail

getName

public String getName()

Gets the landmark name.

Returns:
returns the name of the landmark
Since:
BlackBerry API 4.0.2

setName

public void setName(String name)

Sets the name of the landmark.

Parameters:
name - name for the landmark
Since:
BlackBerry API 4.0.2

getQualifiedCoordinates

public QualifiedCoordinates getQualifiedCoordinates()

Gets the QualifiedCoordinates of the landmark.

Returns:
the QualifiedCoordinates of the landmark. null if not available.
Since:
BlackBerry API 4.0.2

setQualifiedCoordinates

public void setQualifiedCoordinates(QualifiedCoordinates cooordinates)
Sets the QualifiedCoordinates of the landmark.

Parameters:
cooordinates - the qualified coordinates of the landmark
Since:
BlackBerry API 4.0.2

getAddressInfo

public AddressInfo getAddressInfo()

Gets the AddressInfo of the landmark.

Returns:
the AddressInfo of the landmark
Since:
BlackBerry API 4.0.2

setAddressInfo

public void setAddressInfo(AddressInfo addressInfo)
Sets the AddressInfo of the landmark.

Parameters:
addressInfo - the AddressInfo of the landmark
Since:
BlackBerry API 4.0.2

getDescription

public String getDescription()

Gets the landmark description.

Returns:
returns the description of the landmark, null if not available
Since:
BlackBerry API 4.0.2

setDescription

public void setDescription(String description)
Sets the description of the landmark.

Parameters:
description - description for the landmark, null may be passed in to indicate that description is not available.
Since:
BlackBerry API 4.0.2





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.