Package com.atlassian.confluence.velocity.htmlsafe

Class HtmlSafeAnnotationUtils

java.lang.Object
com.atlassian.confluence.velocity.htmlsafe.HtmlSafeAnnotationUtils
@Deprecated(forRemoval=true) public final class HtmlSafeAnnotationUtils extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.0, for removal in 10.0 alongside HtmlSafe.
Utilities for working with the HtmlSafe annotation

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Annotation
    ATLASSIAN_HTML_SAFE_ANNOTATION
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final Annotation
    HTML_SAFE_ANNOTATION
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    containsAnnotationOfType(Collection<Annotation> annotations, Class<? extends Annotation> annotationType)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Detects whether a collection contains an annotation of a particular type
    static boolean
    hasHtmlSafeToStringMethod(Object value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return true if the object has a toString method that has been annotated as HtmlSafe
    static boolean
    isHtmlSafeValue(com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxedElement value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    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 Details

    • HTML_SAFE_ANNOTATION

      public static final Annotation HTML_SAFE_ANNOTATION
      Deprecated, for removal: This API element is subject to removal in a future version.

    • ATLASSIAN_HTML_SAFE_ANNOTATION

      public static final Annotation ATLASSIAN_HTML_SAFE_ANNOTATION
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • hasHtmlSafeToStringMethod

      public static boolean hasHtmlSafeToStringMethod(Object value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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(com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxedElement value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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