Send back identifier, if available.
[Sone.git] / src / main / java / net / pterodactylus / sone / text / FreenetLinkParserContext.java
1 /*
2  * Sone - FreenetLinkParserContext.java - Copyright © 2011 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
22 /**
23  * {@link ParserContext} implementation for the {@link FreenetLinkParser}. It
24  * stores the {@link Sone} that provided the parsed text so that certain links
25  * can be marked in a different way.
26  *
27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
28  */
29 public class FreenetLinkParserContext implements ParserContext {
30
31         /** The posting Sone. */
32         private final Sone postingSone;
33
34         /**
35          * Creates a new link parser context.
36          *
37          * @param postingSone
38          *            The posting Sone
39          */
40         public FreenetLinkParserContext(Sone postingSone) {
41                 this.postingSone = postingSone;
42         }
43
44         /**
45          * Returns the Sone that provided the text that is being parsed.
46          *
47          * @return The posting Sone
48          */
49         public Sone getPostingSone() {
50                 return postingSone;
51         }
52
53 }