Package com.esri.arcgisruntime.tasks.offlinemap

Class OfflineMapItemInfo

  • public final class OfflineMapItemInfo
extends java.lang.Object
    Contains metadata for an offline map item.
    Since:
    100.1.0

    • Constructor Summary

      Constructors 
      Constructor Description
      OfflineMapItemInfo()
      Constructs a new OfflineMapItemInfo instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAccessInformation()
      Gets information on the source of the map and its copyright status.
      java.lang.String getDescription()
      Gets the description of the map.
      java.lang.String getSnippet()
      Gets the summary description snippet of the map.
      java.util.List<java.lang.String> getTags()
      Gets the list of tags associated with the map.
      java.lang.String getTermsOfUse()
      Gets the terms of use for the item.
      byte[] getThumbnailData()
      Gets the thumbnail data for the map, if this has been set using the setThumbnailData method.
      java.lang.String getTitle()
      Gets the title of the map.
      void setAccessInformation​(java.lang.String accessInformation)
      Sets information on the source of the map and its copyright status.
      void setDescription​(java.lang.String description)
      Sets the description of the map.
      void setSnippet​(java.lang.String snippet)
      Sets the summary description snippet of the map.
      void setTermsOfUse​(java.lang.String termsOfUse)
      Sets the terms of use for the item.
      void setThumbnailData​(byte[] thumbnailData)
      Sets the thumbnail data for the map.
      void setTitle​(java.lang.String title)
      Sets the title of the map.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • OfflineMapItemInfo

        public OfflineMapItemInfo()
        Constructs a new OfflineMapItemInfo instance.
        Since:
        100.1.0

    • Method Detail

      • getAccessInformation

        public java.lang.String getAccessInformation()
        Gets information on the source of the map and its copyright status.
        Returns:
        text describing the source of the map and its copyright status
        Since:
        100.1.0

      • setAccessInformation

        public void setAccessInformation​(java.lang.String accessInformation)
        Sets information on the source of the map and its copyright status.
        Parameters:
        accessInformation - text describing the source of the map and its copyright status
        Since:
        100.1.0

      • getDescription

        public java.lang.String getDescription()
        Gets the description of the map.
        Returns:
        the description of the map
        Since:
        100.1.0

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the description of the map.
        Parameters:
        description - the description of the map
        Since:
        100.1.0

      • getSnippet

        public java.lang.String getSnippet()
        Gets the summary description snippet of the map.
        Returns:
        the summary description snippet of the map
        Since:
        100.1.0

      • setSnippet

        public void setSnippet​(java.lang.String snippet)
        Sets the summary description snippet of the map.
        Parameters:
        snippet - the summary description snippet of the map
        Since:
        100.1.0

      • getTags

        public java.util.List<java.lang.String> getTags()
        Gets the list of tags associated with the map. The returned List object is modifiable and changes made to it will affect the tags used by this OfflineMapItemInfo.
        Returns:
        the list of tags associated with the map
        Since:
        100.1.0

      • getTermsOfUse

        public java.lang.String getTermsOfUse()
        Gets the terms of use for the item. This may include HTML markup.
        Returns:
        the terms of use
        Since:
        100.4.0

      • setTermsOfUse

        public void setTermsOfUse​(java.lang.String termsOfUse)
        Sets the terms of use for the item. This may include HTML markup.
        Parameters:
        termsOfUse - the terms of use
        Since:
        100.4.0

      • getThumbnailData

        public byte[] getThumbnailData()
        Gets the thumbnail data for the map, if this has been set using the setThumbnailData method.
        Returns:
        the thumbnail data for the map, or null if this has not been set using setThumbnailData(byte[])
        Since:
        100.1.0

      • setThumbnailData

        public void setThumbnailData​(byte[] thumbnailData)
        Sets the thumbnail data for the map.
        Parameters:
        thumbnailData - a byte array representing the thumbnail. The recommended image size is 200 pixels wide by 133 pixels high. Acceptable image formats are PNG, GIF, and JPEG. The maximum file size for an image is 1 MB.
        Throws:
        java.lang.IllegalArgumentException - if thumbnailData is null or empty
        ArcGISRuntimeException - if thumbnailData is invalid
        Since:
        100.1.0

      • getTitle

        public java.lang.String getTitle()
        Gets the title of the map.
        Returns:
        the title of the map
        Since:
        100.1.0

      • setTitle

        public void setTitle​(java.lang.String title)
        Sets the title of the map.
        Parameters:
        title - the title of the map
        Since:
        100.1.0