Package com.atlassian.confluence.velocity.htmlsafe

Class ConfluenceHtmlAnnotationEscaper

java.lang.Object
com.atlassian.velocity.htmlsafe.introspection.AnnotatedReferenceHandler
com.atlassian.velocity.htmlsafe.HtmlAnnotationEscaper
com.atlassian.confluence.velocity.htmlsafe.ConfluenceHtmlAnnotationEscaper
All Implemented Interfaces:
org.apache.velocity.app.event.EventHandler, org.apache.velocity.app.event.ReferenceInsertionEventHandler
@Deprecated(forRemoval=true) public class ConfluenceHtmlAnnotationEscaper extends com.atlassian.velocity.htmlsafe.HtmlAnnotationEscaper
Deprecated, for removal: This API element is subject to removal in a future version.
since 6.5, for removal in 10.0 alongside HtmlSafe. Use HtmlAnnotationEscaper instead.
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
  • head

  • 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
    Description
    ConfluenceHtmlAnnotationEscaper()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    shouldEscape(String referenceName, Object value, Collection<Annotation> annotations)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class com.atlassian.velocity.htmlsafe.HtmlAnnotationEscaper

    annotatedValueInsert

    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 Details

    • ConfluenceHtmlAnnotationEscaper

      public ConfluenceHtmlAnnotationEscaper()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • shouldEscape

      protected boolean shouldEscape(String referenceName, Object value, Collection<Annotation> annotations)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      shouldEscape in class com.atlassian.velocity.htmlsafe.HtmlAnnotationEscaper