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

Class OutputTypeAwareHrefEvaluator

java.lang.Object

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

All Implemented Interfaces:

HrefEvaluator

public class OutputTypeAwareHrefEvaluator
extends Object
implements HrefEvaluator

An HrefEvaluator which inspects the ConversionContextOutputType in the ConversionContext and evaluates href values appropriately for the output type targeted.

Constructor Summary

Constructors

Constructor and Description
OutputTypeAwareHrefEvaluator(Map<String,HrefEvaluator> outputTypeEvaluators, HrefEvaluator defaultEvaluator)

Method Summary

Modifier and Type	Method and Description
String	createHref(ConversionContext context, Object entity, String anchor) Create the appropriate href attribute value for the supplied ConversionContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputTypeAwareHrefEvaluator

public OutputTypeAwareHrefEvaluator(Map<String,HrefEvaluator> outputTypeEvaluators,
                                    HrefEvaluator defaultEvaluator)

Parameters:

outputTypeEvaluators - a Map where the key is a ConversionContextOutputType and the value is the HrefEvaluator to use for that output type

defaultEvaluator - the HrefEvaluator to use if no specific one is found

Method Detail

createHref

public String createHref(ConversionContext context,
                         Object entity,
                         String anchor)

Description copied from interface: HrefEvaluator

Create the appropriate href attribute value for the supplied ConversionContext.

Specified by:

createHref in interface HrefEvaluator

Parameters:

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

entity - 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.

See Also:

ConversionContextOutputType} for the supported outputType