src/main/java/net/pterodactylus/sone/text/SoneTextParserContext.java

   1 /*
   2  * Sone - SoneTextParserContext.java - Copyright © 2011–2012 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.sone.text;
  19
  20 import net.pterodactylus.sone.data.Sone;
  21 import net.pterodactylus.sone.web.page.FreenetRequest;
  22
  23 /**
  24  * {@link ParserContext} implementation for the {@link SoneTextParser}. It
  25  * stores the {@link Sone} that provided the parsed text so that certain links
  26  * can be marked in a different way.
  27  *
  28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  29  */
  30 public class SoneTextParserContext implements ParserContext {
  31
  32         /** The request being processed. */
  33         private final FreenetRequest request;
  34
  35         /** The posting Sone. */
  36         private final Sone postingSone;
  37
  38         /**
  39          * Creates a new link parser context.
  40          *
  41          * @param request
  42          *            The request being processed
  43          * @param postingSone
  44          *            The posting Sone
  45          */
  46         public SoneTextParserContext(FreenetRequest request, Sone postingSone) {
  47                 this.request = request;
  48                 this.postingSone = postingSone;
  49         }
  50
  51         /**
  52          * Returns the request that is currently being processed.
  53          *
  54          * @return The request being processed
  55          */
  56         public FreenetRequest getRequest() {
  57                 return request;
  58         }
  59
  60         /**
  61          * Returns the Sone that provided the text that is being parsed.
  62          *
  63          * @return The posting Sone
  64          */
  65         public Sone getPostingSone() {
  66                 return postingSone;
  67         }
  68
  69 }