com.atlassian.confluence.velocity.htmlsafe
Class HtmlSafeAnnotationUtils

java.lang.Object
  extended by com.atlassian.confluence.velocity.htmlsafe.HtmlSafeAnnotationUtils

public final class HtmlSafeAnnotationUtils
extends Object

Utilities for working with the HtmlSafe annotation


Field Summary
static Annotation ATLASSIAN_HTML_SAFE_ANNOTATION
           
static Annotation HTML_SAFE_ANNOTATION
           
 
Method Summary
static boolean containsAnnotationOfType(Collection<Annotation> annotations, Class<? extends Annotation> annotationType)
          Detects whether a collection contains an annotation of a particular type
static boolean hasHtmlSafeToStringMethod(Object value)
          Return true if the object has a toString method that has been annotated as HtmlSafe
static boolean isHtmlSafeValue(AnnotationBoxedElement value)
          Determines wheter an annotated value is htmlsafe (i.e should not be encoded during rendering)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HTML_SAFE_ANNOTATION

public static final Annotation HTML_SAFE_ANNOTATION

ATLASSIAN_HTML_SAFE_ANNOTATION

public static final Annotation ATLASSIAN_HTML_SAFE_ANNOTATION
Method Detail

hasHtmlSafeToStringMethod

public static boolean hasHtmlSafeToStringMethod(Object value)
Return true if the object has a toString method that has been annotated as HtmlSafe

Parameters:
value - Object to query
Returns:
true if HTML safe

isHtmlSafeValue

public static boolean isHtmlSafeValue(AnnotationBoxedElement value)
Determines wheter an annotated value is htmlsafe (i.e should not be encoded during rendering)

Parameters:
value - Object to query
Returns:
true if HTML safe

containsAnnotationOfType

public static boolean containsAnnotationOfType(Collection<Annotation> annotations,
                                               Class<? extends Annotation> annotationType)
Detects whether a collection contains an annotation of a particular type

Parameters:
annotations - Collection to scan
annotationType - Annotation type to detect
Returns:
true if annotation type is found


Copyright © 2003-2011 Atlassian. All Rights Reserved.