Package 

Interface Fetcher

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class Fetcher.Companion

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract List<Link> links() Known resources available in the medium, such as file paths on the file system or entries in a ZIP archive.
      abstract Resource get(Link link) Returns the Resource at the given link's HREF.
      Resource get(String href) Returns the Resource at the given href.

      • Methods inherited from class org.readium.r2.shared.util.SuspendingCloseable

        close

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • links

         abstract List<Link> links()

        Known resources available in the medium, such as file paths on the file system or entries in a ZIP archive. This list is not exhaustive, and additional unknown resources might be reachable.

        If the medium has an inherent resource order, it should be followed. Otherwise, HREFs are sorted alphabetically.

      • get

         abstract Resource get(Link link)

        Returns the Resource at the given link's HREF.

        A Resource is always returned, since for some cases we can't know if it exists before actually fetching it, such as HTTP. Therefore, errors are handled at the Resource level.