Package com.atlassian.confluence.content.render.xhtml.links

Interface HrefEvaluator

All Known Implementing Classes:

AbsoluteHrefEvaluator, DefaultHrefEvaluator, HtmlExportHrefEvaluator, OutputTypeAwareHrefEvaluator

public interface HrefEvaluator

The marshalling of links involves creating the actual href attribute describing the destination of the link. This interface describes a class that will create the appropriate href value based on the ConversionContext.

Method Summary

Modifier and Type	Method	Description
default String	createHref(ConversionContext context, WebLink webLink, String anchor)
default String	createHref(ConversionContext context, Addressable addressable, String anchor)
default String	createHref(ConversionContext context, ContentEntityObject content, String anchor)
default String	createHref(ConversionContext context, Attachment attachment, String anchor)
default String	createHref(ConversionContext context, PageTemplate pageTemplate, String anchor)
default String	createHref(ConversionContext context, Space space, String anchor)
default String	createHref(ConversionContext context, ConfluenceUser user, String anchor)
String	createHref(ConversionContext context, Object object, String anchor)	Deprecated. since 9.3 use one of the more strongly-typed methods

Method Details

createHref

@Deprecated(since="9.3")
String createHref(ConversionContext context,
 Object object,
 String anchor)

Deprecated.

since 9.3 use one of the more strongly-typed methods

Create the appropriate href attribute value for the supplied ConversionContext.

Parameters:

context - the ConversionContext providing information about the conversion being performed, including the target output type e.g. display, pdf

object - the object

anchor - an option parameter specifying an anchor component for the href attribute. This may be null if there is no destination anchor.

Returns:

the attribute value appropriate for the outputType specified.

createHref

default String createHref(ConversionContext context,
 WebLink webLink,
 String anchor)

Since:

9.3

createHref

default String createHref(ConversionContext context,
 ConfluenceUser user,
 String anchor)

Since:

9.3

createHref

default String createHref(ConversionContext context,
 Attachment attachment,
 String anchor)

Since:

9.3

createHref

default String createHref(ConversionContext context,
 PageTemplate pageTemplate,
 String anchor)

Since:

9.3

createHref

default String createHref(ConversionContext context,
 ContentEntityObject content,
 String anchor)

Since:

9.3

createHref

default String createHref(ConversionContext context,
 Space space,
 String anchor)

Since:

9.3

createHref

default String createHref(ConversionContext context,
 Addressable addressable,
 String anchor)

Since:

9.3