File LinkQueueItem.java
Coverage histogram
0% of files have more coverage
Classes
| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| LinkQueueItem | 30 | 6 | 0% | 4 | 0 |
Contributing tests
This file is covered by 9 tests.
.
Source view
| 1 | /* | |
| 2 | * See the NOTICE file distributed with this work for additional | |
| 3 | * information regarding copyright ownership. | |
| 4 | * | |
| 5 | * This is free software; you can redistribute it and/or modify it | |
| 6 | * under the terms of the GNU Lesser General Public License as | |
| 7 | * published by the Free Software Foundation; either version 2.1 of | |
| 8 | * the License, or (at your option) any later version. | |
| 9 | * | |
| 10 | * This software is distributed in the hope that it will be useful, | |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 | * Lesser General Public License for more details. | |
| 14 | * | |
| 15 | * You should have received a copy of the GNU Lesser General Public | |
| 16 | * License along with this software; if not, write to the Free | |
| 17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
| 18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
| 19 | */ | |
| 20 | package org.xwiki.rendering.internal.transformation.linkchecker; | |
| 21 | ||
| 22 | import java.util.Map; | |
| 23 | ||
| 24 | /** | |
| 25 | * Represents a Link placed on the queue for checking. | |
| 26 | * | |
| 27 | * @version $Id: 2fe1837655f3e3be0c12a33c2985de0910bb837d $ | |
| 28 | * @since 3.3M1 | |
| 29 | */ | |
| 30 | public class LinkQueueItem | |
| 31 | { | |
| 32 | /** | |
| 33 | * @see #getLinkReference() | |
| 34 | */ | |
| 35 | private String linkReference; | |
| 36 | ||
| 37 | /** | |
| 38 | * @see #getContentReference() | |
| 39 | */ | |
| 40 | private String contentReference; | |
| 41 | ||
| 42 | /** | |
| 43 | * @see #getContextData() | |
| 44 | */ | |
| 45 | private Map<String, Object> contextData; | |
| 46 | ||
| 47 | /** | |
| 48 | * @param linkReference see {@link #getLinkReference()} | |
| 49 | * @param contentReference see {@link #getContentReference()} | |
| 50 | * @param contextData see {@link #getContextData()} | |
| 51 | */ | |
| 52 | 27 |  public LinkQueueItem(String linkReference, String contentReference, Map<String, Object> contextData) |
| 53 | { | |
| 54 | 27 | this.linkReference = linkReference; |
| 55 | 27 | this.contentReference = contentReference; |
| 56 | 27 | this.contextData = contextData; |
| 57 | } | |
| 58 | ||
| 59 | /** | |
| 60 | * @return the reference to the link that needs to be checked | |
| 61 | */ | |
| 62 | 53 | public String getLinkReference() |
| 63 | { | |
| 64 | 53 | return this.linkReference; |
| 65 | } | |
| 66 | ||
| 67 | /** | |
| 68 | * @return the reference to the content, ie where the content was taken from (eg a page reference) | |
| 69 | */ | |
| 70 | 32 | public String getContentReference() |
| 71 | { | |
| 72 | 32 | return this.contentReference; |
| 73 | } | |
| 74 | ||
| 75 | /** | |
| 76 | * @return the context data associated with the content reference. What gets put in the Context Data Map depends | |
| 77 | * purely on implementations of | |
| 78 | * {@link org.xwiki.rendering.transformation.linkchecker.LinkContextDataProvider} | |
| 79 | */ | |
| 80 | 15 | public Map<String, Object> getContextData() |
| 81 | { | |
| 82 | 15 | return this.contextData; |
| 83 | } | |
| 84 | } |