com.atlassian.confluence.it.plugin

Class UploadablePluginBuilder

java.lang.Object

com.atlassian.confluence.it.plugin.UploadablePluginBuilder

public class UploadablePluginBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
UploadablePluginBuilder(String pluginKey, String pluginName)

Method Summary

Modifier and Type	Method and Description
UploadablePluginBuilder	addClass(Class clazz) Helper method to add the .class file for the given class
UploadablePluginBuilder	addClasspathResource(String resourcePath, String classPath)
UploadablePluginBuilder	addFile(String path, File file)
UploadablePluginBuilder	addFormattedJava(String className, String... lines)
UploadablePluginBuilder	addFormattedResource(String path, String... lines)
UploadablePluginBuilder	addJava(String className, String code)
UploadablePluginBuilder	addJavaClass(Class<?> clazz) Adds the given class, and all its nested classes, including anonymous ones (assuming they follow the $n naming convention).
UploadablePluginBuilder	addPluginInformation(String key, String name, String version)
UploadablePluginBuilder	addPluginInformation(String key, String name, String version, int pluginsVersion)
UploadablePluginBuilder	addPluginInformation(String key, String name, String version, int pluginsVersion, Map<String,String> params)
UploadablePluginBuilder	addResource(String path, String contents)
UploadablePlugin	buildUploadablePlugin() WARNING: UploadablePlugin may not be completely filled.
UploadablePluginBuilder	manifest(Map<String,String> manifest)

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadablePluginBuilder

public UploadablePluginBuilder(String pluginKey,
                               String pluginName)

Method Detail

addFormattedJava

public UploadablePluginBuilder addFormattedJava(String className,
                                                String... lines)

addJavaClass

public UploadablePluginBuilder addJavaClass(Class<?> clazz)
                                     throws IOException

Adds the given class, and all its nested classes, including anonymous ones (assuming they follow the $n naming convention).

Parameters:

clazz - the class to add

Returns:

this builder

Throws:

IOException - if the classfile for the given class (or any of its nested classes) cannot be read

addJava

public UploadablePluginBuilder addJava(String className,
                                       String code)

addClass

public UploadablePluginBuilder addClass(Class clazz)
                                 throws IOException

Helper method to add the .class file for the given class

Parameters:

clazz - the class identifying the class file to add

Returns:

this

Throws:

IOException

manifest

public UploadablePluginBuilder manifest(Map<String,String> manifest)

addClasspathResource

public UploadablePluginBuilder addClasspathResource(String resourcePath,
                                                    String classPath)

addResource

public UploadablePluginBuilder addResource(String path,
                                           String contents)

addFormattedResource

public UploadablePluginBuilder addFormattedResource(String path,
                                                    String... lines)

addPluginInformation

public UploadablePluginBuilder addPluginInformation(String key,
                                                    String name,
                                                    String version)

addPluginInformation

public UploadablePluginBuilder addPluginInformation(String key,
                                                    String name,
                                                    String version,
                                                    int pluginsVersion)

addPluginInformation

public UploadablePluginBuilder addPluginInformation(String key,
                                                    String name,
                                                    String version,
                                                    int pluginsVersion,
                                                    Map<String,String> params)

addFile

public UploadablePluginBuilder addFile(String path,
                                       File file)
                                throws IOException

Throws:

IOException

buildUploadablePlugin

public UploadablePlugin buildUploadablePlugin()

WARNING: UploadablePlugin may not be completely filled. TODO - retrieve the pluginKey from the formatted resource or at least allow the key and name to be set independently of the resource.