src/net/pterodactylus/arachne/core/Page.java

   1 /*
   2  * © 2009 David ‘Bombe’ Roden
   3  */
   4 package net.pterodactylus.arachne.core;
   5
   6 /**
   7  * Container for a page. A page consists of an {@link Edition} and a path within
   8  * the edition.
   9  *
  10  * @author David ‘Bombe’ Roden <bombe@pterodactylus.net>
  11  */
  12 public class Page {
  13
  14         /** The edition of the page. */
  15         private final Edition edition;
  16
  17         /** The path of the page. */
  18         private final String path;
  19
  20         /**
  21          * Creates a new page.
  22          *
  23          * @param edition
  24          *            The edition of the page
  25          * @param path
  26          *            The path of the page
  27          */
  28         public Page(Edition edition, String path) {
  29                 this.edition = edition;
  30                 this.path = path;
  31         }
  32
  33         /**
  34          * Returns the edition of the page.
  35          *
  36          * @return The page’s edition
  37          */
  38         public Edition getSite() {
  39                 return edition;
  40         }
  41
  42         /**
  43          * Returns the path of the page within the site.
  44          *
  45          * @return The page’s path
  46          */
  47         public String getPath() {
  48                 return path;
  49         }
  50
  51 }