A B C D E G H I M N P R S T U

A

AnnotatedReferenceHandler - Class in com.atlassian.velocity.htmlsafe.introspection

Support class for ReferenceInsertionEventHandlers that need to deal with any AnnotationBoxedElements context values.

AnnotatedReferenceHandler() - Constructor for class com.atlassian.velocity.htmlsafe.introspection.AnnotatedReferenceHandler

AnnotatedValue<E> - Class in com.atlassian.velocity.htmlsafe.introspection

An annotated value associates a collection of annotations with a value.

AnnotatedValue(E, Collection<Annotation>) - Constructor for class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

Construct a new annotated value.

annotatedValueInsert(String, Object, Collection<Annotation>) - Method in class com.atlassian.velocity.htmlsafe.HtmlAnnotationEscaper

annotatedValueInsert(String, Object, Collection<Annotation>) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedReferenceHandler

Process a reference with a collection of annotations

annotatedValueInsert(String, Object, Collection<Annotation>) - Method in class com.atlassian.velocity.htmlsafe.PossibleIncorrectHtmlEncodingEventHandler

AnnotationBoxedElement<E> - Interface in com.atlassian.velocity.htmlsafe.introspection

This is a union of the BoxedValue and AnnotatedElement interfaces to be implemented by implementations that are responsible for associating annotations with an object.

AnnotationBoxingUberspect - Class in com.atlassian.velocity.htmlsafe.introspection

A Velocity uberspect that boxes return values in an annotated form and unboxes them again when used as arguments to or targets of method calls

AnnotationBoxingUberspect() - Constructor for class com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxingUberspect

argument(boolean) - Static method in class com.atlassian.velocity.htmlsafe.util.Check

Deprecated.

since 1.5. Use Preconditions instead.

argument(boolean, Object) - Static method in class com.atlassian.velocity.htmlsafe.util.Check

Deprecated.

since 1.5. Use Preconditions instead.

B

box(Object) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

This will box another object with the same annotations as this value.

box(Object) - Method in interface com.atlassian.velocity.htmlsafe.introspection.BoxingStrategy

Box the provided value according to the boxing strategy

box(Object) - Method in class com.atlassian.velocity.htmlsafe.introspection.ToStringDelegatingAnnotationBoxedElement

BoxedValue<T> - Interface in com.atlassian.velocity.htmlsafe.introspection

The value represents a boxed value.

BoxingStrategy - Interface in com.atlassian.velocity.htmlsafe.introspection

Interface for classes that provide some strategy for boxing an object

C

Check - Class in com.atlassian.velocity.htmlsafe.util

Deprecated.

since 1.5. Use Preconditions or Objects (Java 8+) instead.

Check() - Constructor for class com.atlassian.velocity.htmlsafe.util.Check

Deprecated.

CollectionInheritable - Annotation Type in com.atlassian.velocity.htmlsafe.annotations

A meta annotation that indicates to the annotation uberspect that the annotation should be retained with every item in a returned collection

com.atlassian.velocity.htmlsafe - package com.atlassian.velocity.htmlsafe

com.atlassian.velocity.htmlsafe.annotations - package com.atlassian.velocity.htmlsafe.annotations

com.atlassian.velocity.htmlsafe.context - package com.atlassian.velocity.htmlsafe.context

com.atlassian.velocity.htmlsafe.directive - package com.atlassian.velocity.htmlsafe.directive

com.atlassian.velocity.htmlsafe.event.referenceinsertion - package com.atlassian.velocity.htmlsafe.event.referenceinsertion

com.atlassian.velocity.htmlsafe.introspection - package com.atlassian.velocity.htmlsafe.introspection

com.atlassian.velocity.htmlsafe.util - package com.atlassian.velocity.htmlsafe.util

containsAnnotationOfType(Collection<Annotation>, Class<? extends Annotation>) - Static method in class com.atlassian.velocity.htmlsafe.HtmlSafeAnnotationUtils

Detects whether a collection contains an annotation of a particular type

D

DefaultDirectiveChecker - Class in com.atlassian.velocity.htmlsafe.directive

Checks whether a directive is present by traversing a Template's AST.

DefaultDirectiveChecker() - Constructor for class com.atlassian.velocity.htmlsafe.directive.DefaultDirectiveChecker

DirectiveChecker - Interface in com.atlassian.velocity.htmlsafe.directive

Checks whether directives are present in templates.

Directives - Class in com.atlassian.velocity.htmlsafe.directive

Contains a set of static utility methods that operate on Velocity Directives.

Directives() - Constructor for class com.atlassian.velocity.htmlsafe.directive.Directives

DisableHtmlEscaping - Class in com.atlassian.velocity.htmlsafe.directive

Represents a marker directive that indicates a template has requested to disable automatic html escaping of references.

DisableHtmlEscaping() - Constructor for class com.atlassian.velocity.htmlsafe.directive.DisableHtmlEscaping

DisableHtmlEscapingDirectiveHandler - Class in com.atlassian.velocity.htmlsafe.event.referenceinsertion

Disables html escaping of references according to the DisableHtmlEscaping directive.

DisableHtmlEscapingDirectiveHandler() - Constructor for class com.atlassian.velocity.htmlsafe.event.referenceinsertion.DisableHtmlEscapingDirectiveHandler

DisableHtmlEscapingDirectiveHandler(ReferenceInsertionEventHandler) - Constructor for class com.atlassian.velocity.htmlsafe.event.referenceinsertion.DisableHtmlEscapingDirectiveHandler

E

EnableHtmlEscaping - Class in com.atlassian.velocity.htmlsafe.directive

Represents a marker directive that indicates a template has requested to enable automatic html escaping of references.

EnableHtmlEscaping() - Constructor for class com.atlassian.velocity.htmlsafe.directive.EnableHtmlEscaping

EnableHtmlEscapingDirectiveHandler - Class in com.atlassian.velocity.htmlsafe.event.referenceinsertion

Enables html escaping of references according to the EnableHtmlEscaping directive.

EnableHtmlEscapingDirectiveHandler() - Constructor for class com.atlassian.velocity.htmlsafe.event.referenceinsertion.EnableHtmlEscapingDirectiveHandler

EnableHtmlEscapingDirectiveHandler(ReferenceInsertionEventHandler) - Constructor for class com.atlassian.velocity.htmlsafe.event.referenceinsertion.EnableHtmlEscapingDirectiveHandler

encode(String) - Static method in class com.atlassian.velocity.htmlsafe.HtmlEntities

endsWithHtmlIgnoreCase(String) - Static method in class com.atlassian.velocity.htmlsafe.HtmlSafeAnnotationUtils

Detects whether or not a symbol ends with "HTML", regardless of case.

equals(Object) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

EventCartridgeProcessingChain - Class in com.atlassian.velocity.htmlsafe.context

Aggregates a set of EventCartridgeProcessors.

EventCartridgeProcessingChain(EventCartridgeProcessor...) - Constructor for class com.atlassian.velocity.htmlsafe.context.EventCartridgeProcessingChain

EventCartridgeProcessor - Interface in com.atlassian.velocity.htmlsafe.context

General interface for classes that process Velocity event cartridges in some way.

G

getAnnotation(Class<T>) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

getAnnotation(Class<T>) - Method in class com.atlassian.velocity.htmlsafe.introspection.ToStringDelegatingAnnotationBoxedElement

getAnnotationCollection() - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

getAnnotationCollection() - Method in interface com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxedElement

getAnnotationCollection() - Method in class com.atlassian.velocity.htmlsafe.introspection.ToStringDelegatingAnnotationBoxedElement

getAnnotations() - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

getAnnotations() - Method in class com.atlassian.velocity.htmlsafe.introspection.ToStringDelegatingAnnotationBoxedElement

getAnnotationsForMethod(Method) - Method in class com.atlassian.velocity.htmlsafe.HtmlSafeClassAnnotator

getAnnotationsForMethod(Method) - Method in class com.atlassian.velocity.htmlsafe.HtmlSafeMethodNameAnnotator

getAnnotationsForMethod(Method) - Method in interface com.atlassian.velocity.htmlsafe.introspection.MethodAnnotator

Return a collection of annotations for a method

getAnnotationsForMethod(Method) - Method in class com.atlassian.velocity.htmlsafe.introspection.MethodAnnotatorChain

getClassForTargetObject(Object) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxingUberspect

Template method for returning the actual concrete class of a the provided object.

getCollectionInheritableAnnotations() - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

getDeclaredAnnotations() - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

getDeclaredAnnotations() - Method in class com.atlassian.velocity.htmlsafe.introspection.ToStringDelegatingAnnotationBoxedElement

getDescription() - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

getIterator(Object, Info) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxingUberspect

Get an iterator responsible for preserving annotations while iterating over a collection that has collection inheritable return value annotations.'

getMethod(Object, String, Object[], Info) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxingUberspect

Return a method that knows how to unbox method call targets and parameters and to box return values according to the return value boxing policy.

getMethodAnnotations(Method) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxingUberspect

Retrieve any annotations on the supplied method that are meta-annotated as a ReturnValueAnnotation

getMethodAnnotations(Method) - Method in class com.atlassian.velocity.htmlsafe.introspection.HtmlSafeAnnotationBoxingUberspect

getName() - Method in class com.atlassian.velocity.htmlsafe.directive.DisableHtmlEscaping

getName() - Method in class com.atlassian.velocity.htmlsafe.directive.EnableHtmlEscaping

getName() - Method in class com.atlassian.velocity.htmlsafe.HtmlSafeDirective

Deprecated.

getPropertyGet(Object, String, Info) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxingUberspect

Get a property getting strategy that will box the end result with any return value annotations on the property getter

getReferenceInsertionEventHandler(Context) - Method in interface com.atlassian.velocity.htmlsafe.ReferenceInsertionPolicy

Get a ReferenceInsertionPolicy appropriate for the context being rendered.

getType() - Method in class com.atlassian.velocity.htmlsafe.directive.DisableHtmlEscaping

getType() - Method in class com.atlassian.velocity.htmlsafe.directive.EnableHtmlEscaping

getType() - Method in class com.atlassian.velocity.htmlsafe.HtmlSafeDirective

Deprecated.

H

hasAnnotation(Class<T>) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

hasAnnotation(Class<T>) - Method in interface com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxedElement

hasAnnotation(Class<T>) - Method in class com.atlassian.velocity.htmlsafe.introspection.ToStringDelegatingAnnotationBoxedElement

hashCode() - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

hasHtmlSafeToStringMethod(Object) - Static method in class com.atlassian.velocity.htmlsafe.HtmlSafeAnnotationUtils

Return true if the object has a toString method that has been annotated as HtmlSafe

HTML_ENTITY_PATTERN - Static variable in class com.atlassian.velocity.htmlsafe.HtmlRegExps

HTML_SAFE_ANNOTATION - Static variable in class com.atlassian.velocity.htmlsafe.HtmlSafeAnnotationUtils

HTML_SAFE_ANNOTATION_COLLECTION - Static variable in class com.atlassian.velocity.htmlsafe.HtmlSafeAnnotationUtils

HTML_TAG_PATTERN - Static variable in class com.atlassian.velocity.htmlsafe.HtmlRegExps

HtmlAnnotationEscaper - Class in com.atlassian.velocity.htmlsafe

A ReferenceInsertionEventHandler that HTML encodes any value not annotated as being HtmlSafe.

HtmlAnnotationEscaper() - Constructor for class com.atlassian.velocity.htmlsafe.HtmlAnnotationEscaper

HtmlEntities - Class in com.atlassian.velocity.htmlsafe

HtmlEntities() - Constructor for class com.atlassian.velocity.htmlsafe.HtmlEntities

HtmlFragment - Class in com.atlassian.velocity.htmlsafe

Simple wrapper class for adding HtmlSafe values directly to a Velocity context.

HtmlFragment(Object) - Constructor for class com.atlassian.velocity.htmlsafe.HtmlFragment

HtmlRegExps - Class in com.atlassian.velocity.htmlsafe

Holder of static regular expression patterns for detecting common HTML structures

HtmlSafe - Annotation Type in com.atlassian.velocity.htmlsafe

Declares that this method returns an object that does not require encoding if it is printed to a HTML document via its Object.toString() method

HtmlSafeAnnotationBoxingUberspect - Class in com.atlassian.velocity.htmlsafe.introspection

Specialisation of the AnnotationBoxingUberspect to be used in a velocity environment.

HtmlSafeAnnotationBoxingUberspect() - Constructor for class com.atlassian.velocity.htmlsafe.introspection.HtmlSafeAnnotationBoxingUberspect

HtmlSafeAnnotationUtils - Class in com.atlassian.velocity.htmlsafe

Utilities for working with the HtmlSafe annotation

HtmlSafeClassAnnotator - Class in com.atlassian.velocity.htmlsafe

This method annotator will annotate various methods that are known to be HTML safe from library classes.

HtmlSafeClassAnnotator() - Constructor for class com.atlassian.velocity.htmlsafe.HtmlSafeClassAnnotator

HtmlSafeDirective - Class in com.atlassian.velocity.htmlsafe

Deprecated.

Since 1.1. Please use DisableHtmlEscaping instead.

HtmlSafeDirective() - Constructor for class com.atlassian.velocity.htmlsafe.HtmlSafeDirective

Deprecated.

HtmlSafeMethodNameAnnotator - Class in com.atlassian.velocity.htmlsafe

Method annotator that marks certain methods as being HtmlSafe based on the method name.

HtmlSafeMethodNameAnnotator() - Constructor for class com.atlassian.velocity.htmlsafe.HtmlSafeMethodNameAnnotator

I

IdentityReferenceInsertionHandler - Class in com.atlassian.velocity.htmlsafe

Identity reference insertion handler.

IdentityReferenceInsertionHandler() - Constructor for class com.atlassian.velocity.htmlsafe.IdentityReferenceInsertionHandler

IncorrectHtmlEncodingWarningProcessor - Class in com.atlassian.velocity.htmlsafe.context

Adds a PossibleIncorrectHtmlEncodingEventHandler to a cartridge if such logging is enabled.

IncorrectHtmlEncodingWarningProcessor() - Constructor for class com.atlassian.velocity.htmlsafe.context.IncorrectHtmlEncodingWarningProcessor

init() - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxingUberspect

InsertionPolicyCartridgeProcessor - Class in com.atlassian.velocity.htmlsafe.context

Adds the necessary event handlers based on the provided ReferenceInsertionPolicy

InsertionPolicyCartridgeProcessor(ReferenceInsertionPolicy) - Constructor for class com.atlassian.velocity.htmlsafe.context.InsertionPolicyCartridgeProcessor

isAnnotationPresent(Class<? extends Annotation>) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

isAnnotationPresent(Class<? extends Annotation>) - Method in class com.atlassian.velocity.htmlsafe.introspection.ToStringDelegatingAnnotationBoxedElement

isHtmlSafeValue(AnnotationBoxedElement<?>) - Static method in class com.atlassian.velocity.htmlsafe.HtmlSafeAnnotationUtils

Determines whether an annotated value is htmlsafe (i.e should not be encoded during rendering)

isLoggingEnabled() - Static method in class com.atlassian.velocity.htmlsafe.PossibleIncorrectHtmlEncodingEventHandler

isPresent(String, Template) - Method in class com.atlassian.velocity.htmlsafe.directive.DefaultDirectiveChecker

isPresent(String, Template) - Method in interface com.atlassian.velocity.htmlsafe.directive.DirectiveChecker

Determines whether a directive with an specified name is present on a template instance.

isPresent(String, Template) - Static method in class com.atlassian.velocity.htmlsafe.directive.Directives

Determines whether a directive with an specified name is present on a template instance.

M

MethodAnnotator - Interface in com.atlassian.velocity.htmlsafe.introspection

Strategy for retrieving annotations for a method

MethodAnnotatorChain - Class in com.atlassian.velocity.htmlsafe.introspection

A method annotator that chains calls to a collection of other annotators

MethodAnnotatorChain(List<MethodAnnotator>) - Constructor for class com.atlassian.velocity.htmlsafe.introspection.MethodAnnotatorChain

N

NoOpEventCartridgeProcessor - Class in com.atlassian.velocity.htmlsafe.context

Cartridge processor that does not do anything to the supplied cartridge

NoOpEventCartridgeProcessor() - Constructor for class com.atlassian.velocity.htmlsafe.context.NoOpEventCartridgeProcessor

notNull(T) - Static method in class com.atlassian.velocity.htmlsafe.util.Check

Deprecated.

since 1.5. Use Preconditions instead.

notNull(T, Object) - Static method in class com.atlassian.velocity.htmlsafe.util.Check

Deprecated.

since 1.5. Use Preconditions instead.

P

PolicyBasedReferenceInsertionHandler - Class in com.atlassian.velocity.htmlsafe

A ReferenceInsertionEventHandler that delegates reference insertion processing to the provided ReferenceInsertionPolicy.

PolicyBasedReferenceInsertionHandler(ReferenceInsertionPolicy) - Constructor for class com.atlassian.velocity.htmlsafe.PolicyBasedReferenceInsertionHandler

PossibleIncorrectHtmlEncodingEventHandler - Class in com.atlassian.velocity.htmlsafe

Reference insertion handler to be used before the HtmlAnnotationEscaper.

PossibleIncorrectHtmlEncodingEventHandler() - Constructor for class com.atlassian.velocity.htmlsafe.PossibleIncorrectHtmlEncodingEventHandler

processCartridge(EventCartridge) - Method in class com.atlassian.velocity.htmlsafe.context.EventCartridgeProcessingChain

processCartridge(EventCartridge) - Method in interface com.atlassian.velocity.htmlsafe.context.EventCartridgeProcessor

Process the provided context in accordance with this processing strategy.

processCartridge(EventCartridge) - Method in class com.atlassian.velocity.htmlsafe.context.IncorrectHtmlEncodingWarningProcessor

processCartridge(EventCartridge) - Method in class com.atlassian.velocity.htmlsafe.context.InsertionPolicyCartridgeProcessor

processCartridge(EventCartridge) - Method in class com.atlassian.velocity.htmlsafe.context.NoOpEventCartridgeProcessor

R

referenceInsert(String, Object) - Method in class com.atlassian.velocity.htmlsafe.event.referenceinsertion.DisableHtmlEscapingDirectiveHandler

referenceInsert(String, Object) - Method in class com.atlassian.velocity.htmlsafe.event.referenceinsertion.EnableHtmlEscapingDirectiveHandler

referenceInsert(String, Object) - Method in class com.atlassian.velocity.htmlsafe.IdentityReferenceInsertionHandler

referenceInsert(String, Object) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedReferenceHandler

referenceInsert(String, Object) - Method in class com.atlassian.velocity.htmlsafe.introspection.TransparentBoxedValueReferenceHandler

referenceInsert(String, Object) - Method in class com.atlassian.velocity.htmlsafe.PolicyBasedReferenceInsertionHandler

ReferenceInsertionPolicy - Interface in com.atlassian.velocity.htmlsafe

Policy interface for Velocity reference insertion strategies that depend on the context being rendered.

render(InternalContextAdapter, Writer, Node) - Method in class com.atlassian.velocity.htmlsafe.directive.DisableHtmlEscaping

render(InternalContextAdapter, Writer, Node) - Method in class com.atlassian.velocity.htmlsafe.directive.EnableHtmlEscaping

render(InternalContextAdapter, Writer, Node) - Method in class com.atlassian.velocity.htmlsafe.HtmlSafeDirective

Deprecated.

ReturnValueAnnotation - Annotation Type in com.atlassian.velocity.htmlsafe.annotations

A meta annotation that indicates to the annotation uberspect that the annotation should be retained with the return value in the Velocity context.

S

setContext(Context) - Method in class com.atlassian.velocity.htmlsafe.event.referenceinsertion.DisableHtmlEscapingDirectiveHandler

setContext(Context) - Method in class com.atlassian.velocity.htmlsafe.event.referenceinsertion.EnableHtmlEscapingDirectiveHandler

setContext(Context) - Method in class com.atlassian.velocity.htmlsafe.PolicyBasedReferenceInsertionHandler

setContext(Context) - Method in class com.atlassian.velocity.htmlsafe.PossibleIncorrectHtmlEncodingEventHandler

setDirectiveChecker(DirectiveChecker) - Method in class com.atlassian.velocity.htmlsafe.event.referenceinsertion.DisableHtmlEscapingDirectiveHandler

Sets the DirectiveChecker that will be used.

setDirectiveChecker(DirectiveChecker) - Method in class com.atlassian.velocity.htmlsafe.event.referenceinsertion.EnableHtmlEscapingDirectiveHandler

Sets the DirectiveChecker that will be used.

setRuntimeServices(RuntimeServices) - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotationBoxingUberspect

shouldEscape(String, Object, Collection<Annotation>) - Method in class com.atlassian.velocity.htmlsafe.HtmlAnnotationEscaper

T

toString() - Method in class com.atlassian.velocity.htmlsafe.HtmlFragment

toString() - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

Delegates and returns the result of calling toString on the boxed value.

toString() - Method in class com.atlassian.velocity.htmlsafe.introspection.ToStringDelegatingAnnotationBoxedElement

ToStringDelegatingAnnotationBoxedElement<E> - Class in com.atlassian.velocity.htmlsafe.introspection

AnnotationBoxedElement that delegates all operations to the wrapped element except for toString() which is delegated to the boxed value itself.

ToStringDelegatingAnnotationBoxedElement(AnnotationBoxedElement<E>) - Constructor for class com.atlassian.velocity.htmlsafe.introspection.ToStringDelegatingAnnotationBoxedElement

TransparentBoxedValueReferenceHandler - Class in com.atlassian.velocity.htmlsafe.introspection

A simple reference insertion handler that unboxes and boxed value references making them transparent during template rendering.

TransparentBoxedValueReferenceHandler() - Constructor for class com.atlassian.velocity.htmlsafe.introspection.TransparentBoxedValueReferenceHandler

U

unbox() - Method in class com.atlassian.velocity.htmlsafe.HtmlFragment

unbox() - Method in class com.atlassian.velocity.htmlsafe.introspection.AnnotatedValue

unbox() - Method in interface com.atlassian.velocity.htmlsafe.introspection.BoxedValue

unbox() - Method in class com.atlassian.velocity.htmlsafe.introspection.ToStringDelegatingAnnotationBoxedElement

A B C D E G H I M N P R S T U