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 String
getCategory()
Gets the category.Credential
getCredential()
Gets theCredential
that is set on the network-enabled resource.String
getKey()
Gets the key.String
getName()
Gets the name of this item.RequestConfiguration
getRequestConfiguration()
Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.Symbol
getSymbol()
Deprecated.as of 100.10.0.ListenableFuture<Symbol>
getSymbolAsync()
Asynchronously returns aSymbol
from the search result.String
getSymbolClass()
Gets the symbol class.List<String>
getTags()
Gets the tags.String
getUri()
Gets the URI of thisRemoteResource
.void
setCredential(Credential credential)
Sets aCredential
to be used by the network-enabled resource in the event of an authentication challenge.void
setRequestConfiguration(RequestConfiguration requestConfiguration)
Sets theRequestConfiguration
used 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 theSymbol
from 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 aSymbol
from 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:RemoteResource
Gets theCredential
that is set on the network-enabled resource.Only applicable if the resource is secured.
- Specified by:
getCredential
in interfaceRemoteResource
- Returns:
- the Credential, or null if there is none
-
setCredential
public void setCredential(Credential credential)
Description copied from interface:RemoteResource
Sets aCredential
to 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:
setCredential
in interfaceRemoteResource
- Parameters:
credential
- the Credential to be used for authentication
-
getRequestConfiguration
public RequestConfiguration getRequestConfiguration()
Description copied from interface:RemoteResource
Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.- Specified by:
getRequestConfiguration
in interfaceRemoteResource
- Returns:
- the
RequestConfiguration
used to modify network requests
-
setRequestConfiguration
public void setRequestConfiguration(RequestConfiguration requestConfiguration)
Description copied from interface:RemoteResource
Sets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
. If not set, the globalRequestConfiguration
will be used (seeRequestConfiguration.getGlobalRequestConfiguration()
).- Specified by:
setRequestConfiguration
in interfaceRemoteResource
- Parameters:
requestConfiguration
- the RequestConfiguration used to modify network requests
-
getUri
public String getUri()
Description copied from interface:RemoteResource
Gets the URI of thisRemoteResource
. Typically this is the URI used to instantiate the object.- Specified by:
getUri
in interfaceRemoteResource
- Returns:
- the URI of this RemoteResource
-
-