com.atlassian.plugins.codegen

Class ComponentDeclaration

java.lang.Object

com.atlassian.plugins.codegen.ComponentDeclaration

All Implemented Interfaces:

PluginProjectChange

public final class ComponentDeclaration
extends Object
implements PluginProjectChange

Describes a <component> element that should be added to the plugin XML file. This is provided in addition to ModuleDescriptor because some other types of modules may also need to create component declarations.

Unlike other classes in this package, this class uses a builder pattern due to the large number of optional properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComponentDeclaration.Builder
static class	ComponentDeclaration.Visibility

Method Summary

Methods

Modifier and Type	Method and Description
static ComponentDeclaration.Builder	builder(ClassId classId, String key)
static ComponentDeclaration	componentDeclaration(ClassId classId, String key)
com.atlassian.fugue.Option<String>	getAlias()
com.atlassian.fugue.Option<String>	getApplication()
ClassId	getClassId()
com.atlassian.fugue.Option<String>	getDescription()
com.atlassian.fugue.Option<String>	getDescriptionI18nKey()
com.atlassian.fugue.Option<ClassId>	getInterfaceId()
String	getKey()
com.atlassian.fugue.Option<String>	getName()
com.atlassian.fugue.Option<String>	getNameI18nKey()
com.google.common.collect.ImmutableMap<String,String>	getServiceProperties()
ComponentDeclaration.Visibility	getVisibility()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ComponentDeclaration.Builder builder(ClassId classId,
                                   String key)

componentDeclaration

public static ComponentDeclaration componentDeclaration(ClassId classId,
                                        String key)

getClassId

public ClassId getClassId()

getKey

public String getKey()

getInterfaceId

public com.atlassian.fugue.Option<ClassId> getInterfaceId()

getVisibility

public ComponentDeclaration.Visibility getVisibility()

getName

public com.atlassian.fugue.Option<String> getName()

getNameI18nKey

public com.atlassian.fugue.Option<String> getNameI18nKey()

getDescription

public com.atlassian.fugue.Option<String> getDescription()

getDescriptionI18nKey

public com.atlassian.fugue.Option<String> getDescriptionI18nKey()

getAlias

public com.atlassian.fugue.Option<String> getAlias()

getApplication

public com.atlassian.fugue.Option<String> getApplication()

getServiceProperties

public com.google.common.collect.ImmutableMap<String,String> getServiceProperties()

toString

public String toString()

Overrides:

toString in class Object