Class Book

  • All Implemented Interfaces:
    Comparable<Book>

    public class Book
    extends Object
    implements Comparable<Book>
    A book contains pages and is the central mechanism for high-level separation of content. Each book usually has its own code repository and a book can be added to multiple webapps.
    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getName

        public String getName()
      • getPathPrefix

        public String getPathPrefix()
        Gets the path prefix for all pages in this book. This will be an empty string for the root book (/).
      • getCvsworkDirectory

        public File getCvsworkDirectory()
      • getParentRefs

        public Set<ParentRef> getParentRefs()
        Gets the parent pages for this book in the context of the current overall content.
      • getCanonicalBase

        public String getCanonicalBase()
        Gets the configured canonicalBase for this book, or null if not configured. Any trailing slash (/) has been stripped from the canonicalBase so can directly concatenate canonicalBase + path
      • getContentRoot

        public PageRef getContentRoot()
        Gets the content root for the book.
      • getCopyright

        public Copyright getCopyright()
        Gets the copyright for the book or null if none declared. As book copyrights are not inherited, all copyright fields will be non-null.
      • getAuthors

        public Set<Author> getAuthors()
        Gets the authors of the book. Any page without more specific authors in itself or a parent (within the book) will use these authors.
      • getTitle

        public String getTitle()
      • getAllowRobots

        public boolean getAllowRobots()
        Gets the allowRobots setting of the book. Any page with an "auto" setting and no parents within the book will use this setting.