Class Guide

java.lang.Object
nl.siegmann.epublib.domain.Guide
All Implemented Interfaces:
Serializable
public class Guide extends Object implements Serializable
The guide is a selection of special pages of the book. Examples of these are the cover, list of illustrations, etc. It is an optional part of an epub, and support for the various types of references varies by reader. The only part of this that is heavily used is the cover page.
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • DEFAULT_COVER_TITLE

      public static final String DEFAULT_COVER_TITLE

    • references

      private List<GuideReference> references

    • COVERPAGE_NOT_FOUND

      private static final int COVERPAGE_NOT_FOUND
      See Also:

    • COVERPAGE_UNITIALIZED

      private static final int COVERPAGE_UNITIALIZED
      See Also:

    • coverPageIndex

      private int coverPageIndex

  • Constructor Details

    • Guide

      public Guide()

  • Method Details

    • getReferences

      public List<GuideReference> getReferences()

    • setReferences

      public void setReferences(List<GuideReference> references)

    • uncheckCoverPage

      private void uncheckCoverPage()

    • getCoverReference

      public GuideReference getCoverReference()

    • setCoverReference

      public int setCoverReference(GuideReference guideReference)

    • checkCoverPage

      private void checkCoverPage()

    • initCoverPage

      private void initCoverPage()

    • getCoverPage

      public Resource getCoverPage()
      The coverpage of the book.
      Returns:
      The coverpage of the book.

    • setCoverPage

      public void setCoverPage(Resource coverPage)

    • addReference

      public ResourceReference addReference(GuideReference reference)

    • getGuideReferencesByType

      public List<GuideReference> getGuideReferencesByType(String referenceTypeName)
      A list of all GuideReferences that have the given referenceTypeName (ignoring case).
      Parameters:
      referenceTypeName -
      Returns:
      A list of all GuideReferences that have the given referenceTypeName (ignoring case).