Class SymbolStyleSearchResult

  • All Implemented Interfaces:
    RemoteResource

    public final class SymbolStyleSearchResult
    extends java.lang.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 Detail

      • getTags

        public java.util.List<java.lang.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 java.lang.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 java.lang.String getSymbolClass()
        Gets the symbol class.
        Returns:
        the symbol class
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android
      • getCategory

        public java.lang.String getCategory()
        Gets the category.
        Returns:
        the category
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android
      • getKey

        public java.lang.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 method getSymbolAsync() for fetching a symbol from the search result.
        Gets the Symbol 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 a Symbol from the search result.
        Returns:
        a ListenableFuture for tracking when the operation is done and getting the result
        Since:
        100.10.0
      • setCredential

        public void setCredential​(Credential credential)
        Description copied from interface: RemoteResource
        Sets a Credential to be used by the network-enabled resource in the event of an authentication challenge. The default credential is null.
        Specified by:
        setCredential in interface RemoteResource
        Parameters:
        credential - the Credential to be used for authentication
      • getUri

        public java.lang.String getUri()
        Description copied from interface: RemoteResource
        Gets the URI of this RemoteResource. Typically this is the URI used to instantiate the object.
        Specified by:
        getUri in interface RemoteResource
        Returns:
        the URI of this RemoteResource