com.atlassian.confluence.velocity.introspection

Class AnnotatedReferenceHandler

java.lang.Object

com.atlassian.confluence.velocity.introspection.AnnotatedReferenceHandler

All Implemented Interfaces:

org.apache.velocity.app.event.EventHandler, org.apache.velocity.app.event.ReferenceInsertionEventHandler

Direct Known Subclasses:

HtmlAnnotationEscaper, PossibleIncorrectHtmlEncodingEventHandler

public abstract class AnnotatedReferenceHandler
extends java.lang.Object
implements org.apache.velocity.app.event.ReferenceInsertionEventHandler

Support class for ReferenceInsertionEventHandlers that need to deal with any AnnotationBoxedElements context values.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.velocity.app.event.ReferenceInsertionEventHandler

org.apache.velocity.app.event.ReferenceInsertionEventHandler.referenceInsertExecutor

Constructor Summary

Constructors

Constructor and Description
AnnotatedReferenceHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract java.lang.Object	annotatedValueInsert(java.lang.String referenceName, java.lang.Object value, java.util.Collection<java.lang.annotation.Annotation> annotations) Process a reference with a collection of annotations
java.lang.Object	referenceInsert(java.lang.String referenceName, java.lang.Object referenceValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedReferenceHandler

public AnnotatedReferenceHandler()

Method Detail

referenceInsert

public java.lang.Object referenceInsert(java.lang.String referenceName,
                               java.lang.Object referenceValue)

Specified by:

referenceInsert in interface org.apache.velocity.app.event.ReferenceInsertionEventHandler

annotatedValueInsert

protected abstract java.lang.Object annotatedValueInsert(java.lang.String referenceName,
                                    java.lang.Object value,
                                    java.util.Collection<java.lang.annotation.Annotation> annotations)

Process a reference with a collection of annotations

Parameters:

referenceName - name of the reference being inserted

value - unboxed reference value

annotations - any annotations associated with the reference

Returns:

Final value to insert