Package com.esri.arcgisruntime.symbology
Class SymbolStyleSearchResult
- java.lang.Object
-
- com.esri.arcgisruntime.symbology.SymbolStyleSearchResult
-
- All Implemented Interfaces:
RemoteResource
public final class SymbolStyleSearchResult extends Object implements RemoteResource
Defines the results from searching through a *.stylx file.Each instance represents a row in the associated *.stylx file. You will be able to access that individual row's symbol, name, category, keys, classes, and associated tags.
- Since:
- 100.0.0 for JavaSE and 100.2.0 for Android
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description StringgetCategory()Gets the category.CredentialgetCredential()Gets theCredentialthat is set on the network-enabled resource.StringgetKey()Gets the key.StringgetName()Gets the name of this item.RequestConfigurationgetRequestConfiguration()Gets theRequestConfigurationused to modify the parameters of network requests made by thisRemoteResource.SymbolgetSymbol()Deprecated.as of 100.10.0.ListenableFuture<Symbol>getSymbolAsync()Asynchronously returns aSymbolfrom the search result.StringgetSymbolClass()Gets the symbol class.List<String>getTags()Gets the tags.StringgetUri()Gets the URI of thisRemoteResource.voidsetCredential(Credential credential)Sets aCredentialto be used by the network-enabled resource in the event of an authentication challenge.voidsetRequestConfiguration(RequestConfiguration requestConfiguration)Sets theRequestConfigurationused to modify the parameters of network requests made by thisRemoteResource.
-
-
-
Method Detail
-
getTags
public List<String> getTags()
Gets the tags.- Returns:
- a unmodifiable list of tags
- Since:
- 100.0.0 for JavaSE and 100.2.0 for Android
-
getName
public String getName()
Gets the name of this item.- Returns:
- the name
- Since:
- 100.0.0 for JavaSE and 100.2.0 for Android
-
getSymbolClass
public String getSymbolClass()
Gets the symbol class.- Returns:
- the symbol class
- Since:
- 100.0.0 for JavaSE and 100.2.0 for Android
-
getCategory
public String getCategory()
Gets the category.- Returns:
- the category
- Since:
- 100.0.0 for JavaSE and 100.2.0 for Android
-
getKey
public String getKey()
Gets the key.- Returns:
- the key
- Since:
- 100.0.0 for JavaSE and 100.2.0 for Android
-
getSymbol
@Deprecated public Symbol getSymbol()
Deprecated.as of 100.10.0. This property has been replaced with an asynchronous methodgetSymbolAsync()for fetching a symbol from the search result.Gets theSymbolfrom the search result.- Returns:
- the symbol from the search result, or null if none
- Since:
- 100.0.0 for JavaSE and 100.2.0 for android
-
getSymbolAsync
public ListenableFuture<Symbol> getSymbolAsync()
Asynchronously returns aSymbolfrom the search result.- Returns:
- a ListenableFuture for tracking when the operation is done and getting the result
- Since:
- 100.10.0
-
getCredential
public Credential getCredential()
Description copied from interface:RemoteResourceGets theCredentialthat is set on the network-enabled resource.Only applicable if the resource is secured.
- Specified by:
getCredentialin interfaceRemoteResource- Returns:
- the Credential, or null if there is none
-
setCredential
public void setCredential(Credential credential)
Description copied from interface:RemoteResourceSets aCredentialto be used by the network-enabled resource in the event of an authentication challenge. The default credential is null.Only applicable if the resource is secured.
- Specified by:
setCredentialin interfaceRemoteResource- Parameters:
credential- the Credential to be used for authentication
-
getRequestConfiguration
public RequestConfiguration getRequestConfiguration()
Description copied from interface:RemoteResourceGets theRequestConfigurationused to modify the parameters of network requests made by thisRemoteResource.- Specified by:
getRequestConfigurationin interfaceRemoteResource- Returns:
- the
RequestConfigurationused to modify network requests
-
setRequestConfiguration
public void setRequestConfiguration(RequestConfiguration requestConfiguration)
Description copied from interface:RemoteResourceSets theRequestConfigurationused to modify the parameters of network requests made by thisRemoteResource. If not set, the globalRequestConfigurationwill be used (seeRequestConfiguration.getGlobalRequestConfiguration()).- Specified by:
setRequestConfigurationin interfaceRemoteResource- Parameters:
requestConfiguration- the RequestConfiguration used to modify network requests
-
getUri
public String getUri()
Description copied from interface:RemoteResourceGets the URI of thisRemoteResource. Typically this is the URI used to instantiate the object.- Specified by:
getUriin interfaceRemoteResource- Returns:
- the URI of this RemoteResource
-
-