com.atlassian.plugin.webresource.impl.annotators

Class ModuleAnnotator

java.lang.Object

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

com.atlassian.plugin.webresource.impl.annotators.ModuleAnnotator

public class ModuleAnnotator
extends ResourceContentAnnotator

Wraps AMD module inside of `WRM.atlassianModule`, needed by AMD loader to resolve dependencies.

Since:

v6.3

Constructor Summary

Constructors

Constructor and Description
ModuleAnnotator()

Method Summary

Modifier and Type	Method and Description
protected void	after(LinkedHashSet<String> requiredResources, Resource resource, Map<String,String> params, OutputStream stream)
void	afterResource(LinkedHashSet<String> requiredResources, String url, Resource resource, Map<String,String> params, OutputStream stream) Called after the resource content is written.
void	afterResourceInBatch(LinkedHashSet<String> requiredResources, Resource resource, Map<String,String> params, OutputStream stream) Called after the resource content is written in batch.
protected int	before(LinkedHashSet<String> requiredResources, Resource resource, Map<String,String> params, OutputStream stream)
int	beforeResource(LinkedHashSet<String> requiredResources, String url, Resource resource, Map<String,String> params, OutputStream stream) Called before the resource content is written.
int	beforeResourceInBatch(LinkedHashSet<String> requiredResources, Resource resource, Map<String,String> params, 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, beforeAllResourcesInBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleAnnotator

public ModuleAnnotator()

Method Detail

beforeResourceInBatch

public int beforeResourceInBatch(LinkedHashSet<String> requiredResources,
                                 Resource resource,
                                 Map<String,String> params,
                                 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.

beforeResource

public int beforeResource(LinkedHashSet<String> requiredResources,
                          String url,
                          Resource resource,
                          Map<String,String> params,
                          OutputStream stream)
                   throws IOException

Description copied from class: ResourceContentAnnotator

Called before the resource content is written.

Overrides:

beforeResource in class ResourceContentAnnotator

Throws:

IOException

afterResourceInBatch

public void afterResourceInBatch(LinkedHashSet<String> requiredResources,
                                 Resource resource,
                                 Map<String,String> params,
                                 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.

afterResource

public void afterResource(LinkedHashSet<String> requiredResources,
                          String url,
                          Resource resource,
                          Map<String,String> params,
                          OutputStream stream)
                   throws IOException

Description copied from class: ResourceContentAnnotator

Called after the resource content is written.

Overrides:

afterResource in class ResourceContentAnnotator

Throws:

IOException

before

protected int before(LinkedHashSet<String> requiredResources,
                     Resource resource,
                     Map<String,String> params,
                     OutputStream stream)
              throws IOException

Throws:

IOException

after

protected void after(LinkedHashSet<String> requiredResources,
                     Resource resource,
                     Map<String,String> params,
                     OutputStream stream)
              throws IOException

Throws:

IOException

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