1 /******************************************************************************* 2 * Copyright (c) 2009, 2018 Mountainminds GmbH & Co. KG and Contributors 3 * All rights reserved. This program and the accompanying materials 4 * are made available under the terms of the Eclipse Public License v1.0 5 * which accompanies this distribution, and is available at 6 * http://www.eclipse.org/legal/epl-v10.html 7 * 8 * Contributors: 9 * Marc R. Hoffmann - initial API and implementation 10 * 11 *******************************************************************************/ 12 package org.jacoco.report.internal.html; 13 14 import org.jacoco.report.internal.ReportOutputFolder; 15 16 /** 17 * Abstraction for items that can be linked to in a report. 18 */ 19 public interface ILinkable { 20 21 /** 22 * Returns a relative link to the item that works from the given base 23 * folder. 24 * 25 * @param base 26 * folder where the link should be inserted 27 * @return relative link or <code>null</code> if the target does not exist 28 */ getLink(final ReportOutputFolder base)29 public String getLink(final ReportOutputFolder base); 30 31 /** 32 * Returns the display label used for the link. 33 * 34 * @return display label 35 */ getLinkLabel()36 public String getLinkLabel(); 37 38 /** 39 * Optional style class to be associated with the link. 40 * 41 * @return link style class or <code>null</code> 42 */ getLinkStyle()43 public String getLinkStyle(); 44 45 } 46