com.inrix.sdk.model

Class SavedLocation

java.lang.Object

com.inrix.sdk.model.Location

com.inrix.sdk.model.SavedLocation

All Implemented Interfaces:

Parcelable, Cloneable

public class SavedLocation
extends Location
implements Parcelable, Cloneable

Represents information about a location that the user manipulates on the client side.

See Also:

LocationsManager.getSavedLocations(com.inrix.sdk.LocationsManager.GetLocationsOptions, com.inrix.sdk.LocationsManager.IGetSavedLocationsResponseListener), LocationsManager.saveLocation(com.inrix.sdk.LocationsManager.SaveLocationOptions, com.inrix.sdk.LocationsManager.ISaveLocationResponseListener)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SavedLocation.LocationType The type of location.

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<SavedLocation>	CREATOR Parcelable creator for this type.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
SavedLocation(String name, SavedLocation.LocationType type, String address, GeoPoint coordinates) Initializes a new instance of the SavedLocation.
SavedLocation(String name, SavedLocation.LocationType type, String address, GeoPoint coordinates, Schedule schedule) Initializes a new instance of the SavedLocation.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
int	describeContents()
boolean	equals(Object o)
ContactInfoCollection	getAssociatedContacts() Gets the collection of ContactInfo associated with this SavedLocation.
Schedule	getSchedule() Get the schedule associated with this saved location.
SavedLocation.LocationType	getType() Gets the type of location, such as home or work.
int	hashCode()
void	setSchedule(Schedule schedule) Set the schedule for this saved location.
void	setType(SavedLocation.LocationType locationType) Sets the type of location, such as home or work.
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class com.inrix.sdk.model.Location

getAddress, getGeoPoint, getName, getTimeZone, setAddress, setGeoPoint, setName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final Parcelable.Creator<SavedLocation> CREATOR

Parcelable creator for this type.

Constructor Detail

SavedLocation

public SavedLocation(@Nullable
             String name,
             @Nullable
             SavedLocation.LocationType type,
             @Nullable
             String address,
             @NonNull
             GeoPoint coordinates)

Initializes a new instance of the SavedLocation.

Parameters:

name - The name of the saved location. May be null.

type - The type of the saved location. (See SavedLocation.LocationType).

address - The address of the saved location. May be null.

coordinates - The saved location's latitude/longitude coordinates. Must not be null.

SavedLocation

public SavedLocation(@Nullable
             String name,
             @Nullable
             SavedLocation.LocationType type,
             @Nullable
             String address,
             @NonNull
             GeoPoint coordinates,
             @Nullable
             Schedule schedule)

Initializes a new instance of the SavedLocation.

Parameters:

name - The name of the saved location. May be null.

type - The type of the saved location. (See SavedLocation.LocationType).

address - The address of the saved location. May be null.

coordinates - The saved location's latitude/longitude coordinates. Must not be null.

schedule - Saved location schedule.

Method Detail

getType

public SavedLocation.LocationType getType()

Gets the type of location, such as home or work.

Returns:

The location type.

See Also:

SavedLocation.LocationType

setType

public void setType(SavedLocation.LocationType locationType)

Sets the type of location, such as home or work.

Parameters:

locationType - The location type.

See Also:

SavedLocation.LocationType

getAssociatedContacts

public ContactInfoCollection getAssociatedContacts()

Gets the collection of ContactInfo associated with this SavedLocation.

Returns:

Collection of associated contacts.

getSchedule

@Nullable
public Schedule getSchedule()

Get the schedule associated with this saved location.

Returns:

SavedLocation schedule.

setSchedule

public void setSchedule(@Nullable
               Schedule schedule)

Set the schedule for this saved location.

A SavedLocation can only have a Schedule.ScheduleType.ARRIVAL schedule since the origin of the trip is unspecified.

Parameters:

schedule - SavedLocation schedule.

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

Overrides:

describeContents in class Location

writeToParcel

public void writeToParcel(Parcel dest,
                 int flags)

Specified by:

writeToParcel in interface Parcelable

Overrides:

writeToParcel in class Location

equals

public boolean equals(Object o)

Overrides:

equals in class Location

hashCode

public int hashCode()

Overrides:

hashCode in class Location

clone

public Object clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object