public abstract class

AbstractAttachmentCopier

extends Object
implements AttachmentDao.AttachmentCopier
java.lang.Object
   ↳ com.atlassian.confluence.pages.persistence.dao.AbstractAttachmentCopier
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This method implements some of the methods from the AttachmentDao.AttachmentCopier interface. It also provides some convenience methods for checking whether a given object is to be included in the copy.

Summary

Fields
protected ProgressMeter progress
Public Constructors
AbstractAttachmentCopier()
Public Methods
void setParentContentToExclude(List<? extends ConfluenceEntityObject> contentList)
Set which parent content should be excluded from the copy.
void setProgressMeter(ProgressMeter progress)
Set the progress meter to report the status of the copy.
void setSpacesToInclude(List<? extends Space> spaceList)
Set which Spaces should be included in the copy.
Protected Methods
List<Space> getSpacesToInclude()
boolean isContentExcluded(ContentEntityObject content)
Returns whether a ContentEntityObject is excluded from the copy
boolean isContentSpaceIncluded(ContentEntityObject content)
Returns whether the content's Space is in the inclusion List.
boolean isSpaceIncluded(Space space)
Returns whether the space is in the inclusion List.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.pages.persistence.dao.AttachmentDao.AttachmentCopier

Fields

protected ProgressMeter progress

Public Constructors

public AbstractAttachmentCopier ()

Public Methods

public void setParentContentToExclude (List<? extends ConfluenceEntityObject> contentList)

Set which parent content should be excluded from the copy.

Parameters
contentList a List of ContentEntityObjects

public void setProgressMeter (ProgressMeter progress)

Set the progress meter to report the status of the copy.

Parameters
progress a ProgressMeter instance

public void setSpacesToInclude (List<? extends Space> spaceList)

Set which Spaces should be included in the copy. If no Spaces are set, then content from all Spaces is included.

Parameters
spaceList a List of Spaces

Protected Methods

protected List<Space> getSpacesToInclude ()

protected boolean isContentExcluded (ContentEntityObject content)

Returns whether a ContentEntityObject is excluded from the copy

Parameters
content the ContentEntityObject to check
Returns
  • true if excluded, false otherwise

protected boolean isContentSpaceIncluded (ContentEntityObject content)

Returns whether the content's Space is in the inclusion List. This method first checks if there are any Space restrictions. If there are none, true is returned. Then checks whether content belongs to a Space. If it is not a SpaceContentEntityObject, false is returned. Otherwise, #isSpaceIncluded() is called.

Parameters
content the ContentEntityObject to check
Returns
  • true if it is included, false otherwise

protected boolean isSpaceIncluded (Space space)

Returns whether the space is in the inclusion List.

Parameters
space the Space to check
Returns
  • true if it is included, false otherwise