Jump to Content

Class DesiredCatalog

DesiredCatalog (API Reference)

java.lang.Object
- com.here.sdk.core.engine.DesiredCatalog

```
public final class DesiredCatalog
extends java.lang.Object
```
This class provides an interface to the user, to identify a catalog on the HERE platform, whose data he wants to access. The user can specify the HERE Resource Name (HRN) for the catalog along with a hint for the desired version. If the desired version is not available, the HERE platform will determine the best version to use for a specific catalog or result in error logs. For information on how to specify the catalog version, see CatalogVersionHint. For information about catalogs and related concepts see CatalogIdentifier.

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  CatalogIdentifier id
  The identifier for the catalog to be accessed on the HERE platform.
- Constructor Summary
  
  Constructors
  Constructor Description
  
  DesiredCatalog(java.lang.String hrn, CatalogVersionHint version)
  Creates a new instance.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  boolean equals(java.lang.Object obj)
  
  int hashCode()
  - Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
@NonNull
public CatalogIdentifier id
```
    The identifier for the catalog to be accessed on the HERE platform. See CatalogIdentifier.
- Constructor Detail
  - DesiredCatalog
```
public DesiredCatalog(@NonNull
                      java.lang.String hrn,
                      @NonNull
                      CatalogVersionHint version)
```
    Creates a new instance.
    
    Parameters:
    
    hrn -
    A HERE Resource Name (HRN) for this catalog. This is a unique string returned by the HERE platform when you add a new catalog to your project. For more information, see CatalogIdentifier.hrn
    
    version -
    The version to use for this Catalog's data. You should use either CatalogVersionHint.specific(long) to specify a specific version of the catalog or CatalogVersionHint.latest(boolean) to access the latest version of the catalog available on the HERE platform. Based on the value in this field, the HERE platform will determine the best version to use for this catalog or result in error logs if the desired version is not available.
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object