com.atlassian.velocity.htmlsafe

Class HtmlAnnotationEscaper

java.lang.Object

com.atlassian.velocity.htmlsafe.introspection.AnnotatedReferenceHandler

com.atlassian.velocity.htmlsafe.HtmlAnnotationEscaper

All Implemented Interfaces:

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

public class HtmlAnnotationEscaper
extends AnnotatedReferenceHandler

A ReferenceInsertionEventHandler that HTML encodes any value not annotated as being HtmlSafe. It also excludes some references from escaping based on name:

• Those ending in "html"
• xHtmlContent
• body

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
HtmlAnnotationEscaper()

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	annotatedValueInsert(String referenceName, Object value, Collection<Annotation> annotations) Process a reference with a collection of annotations
protected boolean	shouldEscape(String referenceName, Object value, Collection<Annotation> annotations)

Methods inherited from class com.atlassian.velocity.htmlsafe.introspection.AnnotatedReferenceHandler

referenceInsert

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlAnnotationEscaper

public HtmlAnnotationEscaper()

Method Detail

annotatedValueInsert

protected Object annotatedValueInsert(String referenceName,
                          Object value,
                          Collection<Annotation> annotations)

Description copied from class: AnnotatedReferenceHandler

Process a reference with a collection of annotations

Specified by:

annotatedValueInsert in class AnnotatedReferenceHandler

Parameters:

referenceName - name of the reference being inserted

value - unboxed reference value

annotations - any annotations associated with the reference

Returns:

Final value to insert

shouldEscape

protected boolean shouldEscape(String referenceName,
                   Object value,
                   Collection<Annotation> annotations)