src/main/java/net/pterodactylus/rhynodge/states/HtmlState.java

   1 /*
   2  * Rhynodge - HtmlState.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.rhynodge.states;
  19
  20 import net.pterodactylus.rhynodge.State;
  21
  22 import org.jsoup.nodes.Document;
  23
  24 /**
  25  * {@link State} implementation that contains a parsed HTML {@link Document}.
  26  *
  27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  28  */
  29 public class HtmlState extends AbstractState {
  30
  31         /** The URI of the parsed document. */
  32         private final String uri;
  33
  34         /** The parsed document. */
  35         private final Document document;
  36
  37         /**
  38          * Creates a new HTML state.
  39          *
  40          * @param uri
  41          *            The URI of the parsed document
  42          * @param document
  43          *            The parsed documnet
  44          */
  45         public HtmlState(String uri, Document document) {
  46                 this.uri = uri;
  47                 this.document = document;
  48         }
  49
  50         //
  51         // ACCESSORS
  52         //
  53
  54         /**
  55          * Returns the URI of the parsed document.
  56          *
  57          * @return The URI of the parsed document
  58          */
  59         public String uri() {
  60                 return uri;
  61         }
  62
  63         /**
  64          * Returns the parsed document.
  65          *
  66          * @return The parsed document
  67          */
  68         public Document document() {
  69                 return document;
  70         }
  71
  72         //
  73         // OBJECT METHODS
  74         //
  75
  76         /**
  77          * {@inheritDoc}
  78          */
  79         @Override
  80         public String toString() {
  81                 return String.format("%s[document=(%s chars)]", getClass().getSimpleName(), document().toString().length());
  82         }
  83
  84 }