com.atlassian.plugin.webresource.impl.annotators

Class SemicolonResourceContentAnnotator

java.lang.Object

com.atlassian.plugin.webresource.impl.annotators.ResourceContentAnnotator

com.atlassian.plugin.webresource.impl.annotators.SemicolonResourceContentAnnotator

public class SemicolonResourceContentAnnotator
extends ResourceContentAnnotator

Prepend and append a semicolon.

If a JavaScript file follows another that doesn't end with a semicolon, when it's batched, it's possible for the semantics of the JavaScript to change. Consider the following:

// FILE ONE.js
 console.log("Loading...")

 // FILE TWO.js
 (function () {})()

When batched, it's turned into:

console.log("Loading...")(function () {})()

(Notice that the result of `console.log` is being *executed* with `function () {}` passed in as an argument. This means you'll get an exception like this:

TypeError: undefined is not a function

This is a stateless implementation of the ResourceContentAnnotator that will write a semicolon before and after each resource.

Since:

3.1.1

Constructor Summary

Constructors

Constructor and Description
SemicolonResourceContentAnnotator()

Method Summary

Modifier and Type	Method and Description
void	afterResourceInBatch(LinkedHashSet<String> requiredResources, Resource resource, OutputStream stream) Called after the resource content is written in batch.
int	beforeResourceInBatch(LinkedHashSet<String> requiredResources, Resource resource, OutputStream stream) Called before the resource content is written in batch.
int	hashCode() Produce a hash for this instance.

Methods inherited from class com.atlassian.plugin.webresource.impl.annotators.ResourceContentAnnotator

afterAllResourcesInBatch, afterResource, beforeAllResourcesInBatch, beforeResource

Methods inherited from class java.lang.Object

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

Constructor Detail

SemicolonResourceContentAnnotator

public SemicolonResourceContentAnnotator()

Method Detail

beforeResourceInBatch

public int beforeResourceInBatch(LinkedHashSet<String> requiredResources,
                                 Resource resource,
                                 OutputStream stream)
                          throws IOException

Description copied from class: ResourceContentAnnotator

Called before the resource content is written in batch.

Overrides:

beforeResourceInBatch in class ResourceContentAnnotator

Returns:

amount of lines the annotator adds to the source, used for source map generation.

Throws:

IOException - if there is a problem writing the annotation.

afterResourceInBatch

public void afterResourceInBatch(LinkedHashSet<String> requiredResources,
                                 Resource resource,
                                 OutputStream stream)
                          throws IOException

Description copied from class: ResourceContentAnnotator

Called after the resource content is written in batch.

Overrides:

afterResourceInBatch in class ResourceContentAnnotator

Throws:

IOException - if there is a problem writing the annotation.

hashCode

public int hashCode()

Description copied from class: ResourceContentAnnotator

Produce a hash for this instance. Should be stable across jvms.

Specified by:

hashCode in class ResourceContentAnnotator