com.atlassian.plugin.webresource.transformer

Class CharSequenceDownloadableResource

java.lang.Object

com.atlassian.plugin.webresource.transformer.AbstractTransformedDownloadableResource

com.atlassian.plugin.webresource.transformer.CharSequenceDownloadableResource

All Implemented Interfaces:

com.atlassian.plugin.servlet.DownloadableResource

Direct Known Subclasses:

SearchAndReplaceDownloadableResource

public abstract class CharSequenceDownloadableResource
extends AbstractTransformedDownloadableResource

Abstract class that makes it easy to create transforms that go from string to string. Override encoding() to customize the character encoding of the underlying content and transformed content.

For example, here is a minimal transformer that prepends text to the underlying resource:

 public class PrefixTransformer implements WebResourceTransformer
   {
       public DownloadableResource transform(Element configElement, ResourceLocation location, String filePath, DownloadableResource nextResource)
       {
           return new CharSequenceDownloadableResource(nextResource)
           {
               protected CharSequence transform(CharSequence originalContent)
               {
                   return "Prefix: "  + originalContent;
               }
           };
       }
    }
 

Since:

2.9.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CharSequenceDownloadableResource(com.atlassian.plugin.servlet.DownloadableResource originalResource)

Method Summary

Modifier and Type	Method and Description
protected Charset	encoding()
void	streamResource(OutputStream out)
protected abstract CharSequence	transform(CharSequence original) Override this method to transform the original content into a new format.

Methods inherited from class com.atlassian.plugin.webresource.transformer.AbstractTransformedDownloadableResource

getContentType, getOriginalResource, isResourceModified, serveResource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CharSequenceDownloadableResource

protected CharSequenceDownloadableResource(com.atlassian.plugin.servlet.DownloadableResource originalResource)

Method Detail

streamResource

public void streamResource(OutputStream out)
                    throws com.atlassian.plugin.servlet.DownloadException

Throws:

com.atlassian.plugin.servlet.DownloadException

encoding

protected Charset encoding()

transform

protected abstract CharSequence transform(CharSequence original)

Override this method to transform the original content into a new format.

Parameters:

original - The content from the original resource.

Returns:

transformed content