Interface CloudFontCollection


  • public interface CloudFontCollection
    A collection of cloud fonts. Calling any method may incur an intial network request to retrieve metadata.
    Since:
    3.4
    Author:
    Chris Jennings
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      CloudFontFamily[] getFamilies()
      Returns an array of available families in this cloud collection.
      CloudFontFamily getFamily​(java.lang.String name)
      Returns a family by name.
      CloudFontFamily[] match​(java.lang.String description)
      Attempts to locate a font family in the collection that matches the description, which should be a family name or part of a family name.
      void refresh()
      Requests that the collection refresh its metadata from the cloud.
    • Method Detail

      • getFamilies

        CloudFontFamily[] getFamilies()
                               throws java.io.IOException
        Returns an array of available families in this cloud collection.
        Returns:
        an array of available families
        Throws:
        java.io.IOException - if an exception occurs while getting family metadata
      • getFamily

        CloudFontFamily getFamily​(java.lang.String name)
                           throws java.io.IOException
        Returns a family by name.
        Parameters:
        name - the name of the family to locate
        Returns:
        the matching family, or null
        Throws:
        java.io.IOException - if an exception occurs while getting family metadata
      • match

        CloudFontFamily[] match​(java.lang.String description)
                         throws java.io.IOException
        Attempts to locate a font family in the collection that matches the description, which should be a family name or part of a family name.
        Parameters:
        description - the description to match, case insensitive
        Returns:
        an array of all matching families, possibly empty
        Throws:
        java.io.IOException - if an exception occurs while getting family metadata
      • refresh

        void refresh()
              throws java.io.IOException
        Requests that the collection refresh its metadata from the cloud.
        Throws:
        java.io.IOException