com.atlassian.velocity.htmlsafe
Class HtmlSafeClassAnnotator

java.lang.Object
  com.atlassian.velocity.htmlsafe.HtmlSafeClassAnnotator

All Implemented Interfaces:

MethodAnnotator

public final class HtmlSafeClassAnnotator
extends java.lang.Object
implements MethodAnnotator

This method annotator will annotate various methods that are known to be HTML safe from library classes. At present this annotator will annotate the htmlEncode method from com.opensymphony.util.TextUtils and com.opensymphony.webwork.util.WebWorkUtil, the html method from org.apache.velocity.tools.generic.EscapeTool as being HTML safe.

Constructor Summary

HtmlSafeClassAnnotator()

Method Summary

java.util.Collection<java.lang.annotation.Annotation>

getAnnotationsForMethod(java.lang.reflect.Method method) Return a collection of annotations for a method

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlSafeClassAnnotator

public HtmlSafeClassAnnotator()

Method Detail

getAnnotationsForMethod

public java.util.Collection<java.lang.annotation.Annotation> getAnnotationsForMethod(java.lang.reflect.Method method)

Description copied from interface: MethodAnnotator

Return a collection of annotations for a method

Specified by:

getAnnotationsForMethod in interface MethodAnnotator

Parameters:

method - Method to annotate

Returns:

A collection of annotations applicable for the method