com.atlassian.confluence.plugins.createcontent.impl

Class AbstractAoManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

java.lang.Object

com.atlassian.confluence.plugins.createcontent.impl.AbstractAoManager<O,A>

All Implemented Interfaces:

AoBackedManager<O,A>

Direct Known Subclasses:

DefaultContentBlueprintManager, DefaultContentTemplateRefManager, DefaultSpaceBlueprintManager

public abstract class AbstractAoManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>
extends Object
implements AoBackedManager<O,A>

Field Summary

Fields

Modifier and Type	Field and Description
protected com.atlassian.activeobjects.external.ActiveObjects	activeObjects
protected HelperAoManager<A>	helperAoManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAoManager(com.atlassian.activeobjects.external.ActiveObjects activeObjects, Class<A> aoClass)

Method Summary

Modifier and Type	Method and Description
protected abstract O	build(A ao)
O	create(O original) Create a new Object of kind O and stores it on AO
A	createAo(O original) Create a new Object of kind O and stores it on AO
void	delete(A object) Deletes an existing object using the AO reference
boolean	delete(UUID id) Deletes an existing object
int	deleteAll() Deletes all objects.
List<O>	getAll() Gets all objects for this manager
protected List<O>	getAll(String query, Object... args)
A	getAoById(UUID id) Find an object by its unique id.
protected A[]	getAosByModuleCompleteKey(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey, boolean pluginClone) Find one object (if pluginClone == true) / multiple objects (if pluginclone == false) by its module complete key
O	getById(UUID id) Find an object by its unique id.
O	getCloneByModuleCompleteKey(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey) Find an object by its module complete key (only for plugin backed objects)
List<O>	getNonClonesByModuleCompleteKey(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey) Find an object by its module complete key (only for plugin backed objects)
protected abstract A	internalCreateAo(O original)
protected void	internalDeleteAllAo(A[] aos)
protected abstract void	internalDeleteAo(A ao)
protected A	internalGetAoById(UUID id)
protected A[]	internalGetAosByModuleCompleteKey(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey, boolean pluginClone)
protected abstract A	internalUpdateAo(O object)
O	update(O object) Updates an existing object.
A	updateAo(O object) Updates an existing object.

Methods inherited from class java.lang.Object

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

Field Detail

activeObjects

protected final com.atlassian.activeobjects.external.ActiveObjects activeObjects

helperAoManager

protected final HelperAoManager<A extends PluginBackedBlueprintAo> helperAoManager

Constructor Detail

AbstractAoManager

protected AbstractAoManager(@Nonnull
                            com.atlassian.activeobjects.external.ActiveObjects activeObjects,
                            @Nonnull
                            Class<A> aoClass)

Method Detail

getById

@Nullable
public O getById(@Nonnull
                           UUID id)

Description copied from interface: AoBackedManager

Find an object by its unique id.

Specified by:

getById in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

getAoById

@Nullable
public A getAoById(@Nonnull
                             UUID id)

Description copied from interface: AoBackedManager

Find an object by its unique id.

Specified by:

getAoById in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

getCloneByModuleCompleteKey

@Nullable
public O getCloneByModuleCompleteKey(@Nonnull
                                               com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey)

Description copied from interface: AoBackedManager

Find an object by its module complete key (only for plugin backed objects)

Specified by:

getCloneByModuleCompleteKey in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

getNonClonesByModuleCompleteKey

@Nonnull
public List<O> getNonClonesByModuleCompleteKey(@Nonnull
                                                        com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey)

Description copied from interface: AoBackedManager

Find an object by its module complete key (only for plugin backed objects)

Specified by:

getNonClonesByModuleCompleteKey in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

getAosByModuleCompleteKey

@Nonnull
protected A[] getAosByModuleCompleteKey(@Nonnull
                                                 com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey,
                                                 boolean pluginClone)

Find one object (if pluginClone == true) / multiple objects (if pluginclone == false) by its module complete key

getAll

@Nonnull
public List<O> getAll()

Description copied from interface: AoBackedManager

Gets all objects for this manager

Specified by:

getAll in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

Returns:

a list with all the objects for this manager

getAll

@Nonnull
protected List<O> getAll(String query,
                                  Object... args)

create

@Nonnull
public O create(@Nonnull
                         O original)

Description copied from interface: AoBackedManager

Create a new Object of kind O and stores it on AO

Specified by:

create in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

Returns:

a new object based on the original one, but backed by AO

createAo

@Nonnull
public A createAo(@Nonnull
                           O original)

Description copied from interface: AoBackedManager

Create a new Object of kind O and stores it on AO

Specified by:

createAo in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

Returns:

a new object based on the original one, but backed by AO

update

@Nonnull
public final O update(@Nonnull
                               O object)

Description copied from interface: AoBackedManager

Updates an existing object.

Specified by:

update in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

updateAo

@Nonnull
public final A updateAo(@Nonnull
                                 O object)

Description copied from interface: AoBackedManager

Updates an existing object.

Specified by:

updateAo in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

delete

public final boolean delete(@Nonnull
                            UUID id)

Description copied from interface: AoBackedManager

Deletes an existing object

Specified by:

delete in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

Returns:

true if the object was deleted (i.e. it really existed and it was correctly deleted), false otherwise

delete

public final void delete(@Nonnull
                         A object)

Description copied from interface: AoBackedManager

Deletes an existing object using the AO reference

Specified by:

delete in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

deleteAll

public final int deleteAll()

Description copied from interface: AoBackedManager

Deletes all objects. Normally only used in acceptance tests.

Specified by:

deleteAll in interface AoBackedManager<O extends PluginBackedBlueprint,A extends PluginBackedBlueprintAo>

Returns:

the number of Blueprints deleted

internalGetAosByModuleCompleteKey

@Nonnull
protected A[] internalGetAosByModuleCompleteKey(@Nonnull
                                                         com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey,
                                                         boolean pluginClone)

internalGetAoById

@Nullable
protected A internalGetAoById(@Nonnull
                                        UUID id)

internalCreateAo

@Nonnull
protected abstract A internalCreateAo(@Nonnull
                                               O original)

internalUpdateAo

@Nonnull
protected abstract A internalUpdateAo(@Nonnull
                                               O object)

internalDeleteAo

protected abstract void internalDeleteAo(@Nonnull
                                         A ao)

internalDeleteAllAo

protected void internalDeleteAllAo(@Nonnull
                                   A[] aos)

build

@Nonnull
protected abstract O build(@Nonnull
                                    A ao)