public abstract class

CharSequenceDownloadableResource

extends AbstractTransformedDownloadableResource
java.lang.Object
   ↳ com.atlassian.plugin.webresource.transformer.AbstractTransformedDownloadableResource
     ↳ com.atlassian.plugin.webresource.transformer.CharSequenceDownloadableResource

Class Overview

Abstract class that makes it easy to create transforms that go from string to string. Override #getEncoding() 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;
               }
           };
       }
    }
 

Summary

Protected Constructors
CharSequenceDownloadableResource(DownloadableResource originalResource)
Public Methods
void streamResource(OutputStream out)
Protected Methods
Charset encoding()
abstract CharSequence transform(CharSequence original)
Override this method to transform the original content into a new format.
[Expand]
Inherited Methods
From class com.atlassian.plugin.webresource.transformer.AbstractTransformedDownloadableResource
From class java.lang.Object
From interface com.atlassian.plugin.servlet.DownloadableResource

Protected Constructors

protected CharSequenceDownloadableResource (DownloadableResource originalResource)

Public Methods

public void streamResource (OutputStream out)

Protected Methods

protected Charset encoding ()

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