Package com.atlassian.plugin.webresource.impl.annotators

Class ListOfAnnotators

java.lang.Object

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

com.atlassian.plugin.webresource.impl.annotators.ListOfAnnotators

public class ListOfAnnotators
extends ResourceContentAnnotator

Helper to simplify working with multiple annotators.

Since:

v 3.4.2

Constructor Summary

Constructors

Constructor	Description
ListOfAnnotators(List<ResourceContentAnnotator> annotators)

Method Summary

Modifier and Type	Method	Description
void	afterAllResourcesInBatch(LinkedHashSet<String> requiredResources, String url, Map<String,String> params, OutputStream stream)	Called after all content is written in batch.
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.
int	beforeAllResourcesInBatch(LinkedHashSet<String> requiredResources, String url, Map<String,String> params, OutputStream stream)	Called before all content is written in batch.
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 java.lang.Object

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

Constructor Details

ListOfAnnotators

public ListOfAnnotators(List<ResourceContentAnnotator> annotators)

Method Details

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.

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.

beforeAllResourcesInBatch

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

Description copied from class: ResourceContentAnnotator

Called before all content is written in batch.

Overrides:

beforeAllResourcesInBatch in class ResourceContentAnnotator

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,
 Map<String,String> params,
 OutputStream stream)
                              throws IOException

Description copied from class: ResourceContentAnnotator

Called after all content is written in batch.

Overrides:

afterAllResourcesInBatch in class ResourceContentAnnotator

Throws:

IOException

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

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

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