com.atlassian.plugin.webresource.impl.annotators

Class ResourceContentAnnotator

java.lang.Object

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

Direct Known Subclasses:

ListOfAnnotators, LocationContentAnnotator, ModuleAnnotator, SemicolonResourceContentAnnotator, TryCatchJsResourceContentAnnotator

public abstract class ResourceContentAnnotator
extends Object

Implemented by classes that want to annotate the write of a plugin resource.

Constructor Summary

Constructors

Constructor and Description
ResourceContentAnnotator()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceContentAnnotator

public ResourceContentAnnotator()

Method Detail

beforeResourceInBatch

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

Called before the resource content is written in batch.

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

Called after the resource content is written in batch.

Throws:

IOException - if there is a problem writing the annotation.

beforeAllResourcesInBatch

public int beforeAllResourcesInBatch(LinkedHashSet<String> requiredResources,
                                     String url,
                                     OutputStream stream)
                              throws IOException

Called before all content is written in batch.

Returns:

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

Throws:

IOException

afterAllResourcesInBatch

public void afterAllResourcesInBatch(LinkedHashSet<String> requiredResources,
                                     String url,
                                     OutputStream stream)
                              throws IOException

Called after all content is written in batch.

Throws:

IOException

beforeResource

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

Called before the resource content is written.

Throws:

IOException

afterResource

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

Called after the resource content is written.

Throws:

IOException

hashCode

public abstract int hashCode()

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

Overrides:

hashCode in class Object