PackageInfo
extends Object| java.lang.Object | |
| ↳ | com.carto.packagemanager.PackageInfo |
Class Overview
Information about map package. This includes id, type, version, name, description and size.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
PackageInfo(String packageId, PackageType packageType, int version, BigInteger size, String serverURL, PackageTileMask tileMask, PackageMetaInfo metaInfo)
Constructs a new package info instance.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void | delete() | ||||||||||
| boolean |
equals(Object obj)
Checks if this object is equal to the specified object.
| ||||||||||
| PackageMetaInfo |
getMetaInfo()
Returns package meta info.
| ||||||||||
| String |
getName()
Returns the default name (short description) of the package.
| ||||||||||
| StringVector |
getNames(String lang)
Returns the names (short description) of the package.
| ||||||||||
| String |
getPackageId()
Returns the internal package id.
| ||||||||||
| PackageType |
getPackageType()
Returns the package type.
| ||||||||||
| BigInteger |
getSize()
Returns the size of the package in bytes.
| ||||||||||
| PackageTileMask |
getTileMask()
Returns the encoded tile mask of the package.
| ||||||||||
| int |
getVersion()
Returns the package version.
| ||||||||||
| int |
hashCode()
Returns the hash value of this object.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public PackageInfo (String packageId, PackageType packageType, int version, BigInteger size, String serverURL, PackageTileMask tileMask, PackageMetaInfo metaInfo)
Constructs a new package info instance.
Parameters
| packageId | The unique id of the package |
|---|---|
| packageType | The type of the package |
| version | The increasing version number of the package |
| size | Size of the package in bytes |
| serverURL | Location of the package |
| tileMask | The tile mask of the package |
| metaInfo | Package meta info |
Public Methods
public synchronized void delete ()
public boolean equals (Object obj)
Checks if this object is equal to the specified object.
Parameters
| obj | The reference object. |
|---|
Returns
- True when objects are equal, false otherwise.
public PackageMetaInfo getMetaInfo ()
Returns package meta info. If package contains no meta info, null is returned.
Returns
- The package meta info.
public String getName ()
Returns the default name (short description) of the package. It is better to use getNames method instead, as each package may contain multiple names.
The name returned is generic name or if that is not available, then English name.
Returns
- The list of names for the package in the specified language (if not available, generic/English names are returned)
public StringVector getNames (String lang)
Returns the names (short description) of the package. This can be displayed to the user. Each package may have multiple names, if the package has multiple classifications.
Note: this information is dervied from package meta info, "name_XXX" fields.
Parameters
| lang | The language for the name |
|---|
Returns
- The list of names for the package in the specified language (if not available, generic/English names are returned)
public String getPackageId ()
Returns the internal package id. This should not be displayed to the user.
Returns
- The unique package id
public PackageType getPackageType ()
Returns the package type.
Returns
- The package type (map, routing, etc)
public BigInteger getSize ()
Returns the size of the package in bytes. This can be displayed to the user.
Returns
- The size of the package in bytes
public PackageTileMask getTileMask ()
Returns the encoded tile mask of the package. This is available for map packages but not for routing packages.
This should not be displayed to the user.
Returns
- The tile mask of the package
public int getVersion ()
Returns the package version. This should not be displayed to the user.
Returns
- The increasing package version number
public int hashCode ()
Returns the hash value of this object.
Returns
- The hash value of this object.