com.atlassian.confluence.plugins.rest.entities.builders

Class DefaultContentEntityBuilder<T extends ContentEntityObject>

java.lang.Object

com.atlassian.confluence.plugins.rest.entities.builders.DefaultContentEntityBuilder<T>

All Implemented Interfaces:

ContentEntityBuilder<T>, SearchEntityBuilder

Direct Known Subclasses:

CustomContentEntityBuilder, WikiLinkableContentEntityBuilder

public class DefaultContentEntityBuilder<T extends ContentEntityObject>
extends Object
implements SearchEntityBuilder, ContentEntityBuilder<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected SettingsManager	settingsManager

Constructor Summary

Constructors

Constructor and Description
DefaultContentEntityBuilder(SettingsManager settingsManager, DateEntityFactory dateEntityFactory, UserEntityHelper userEntityHelper)
DefaultContentEntityBuilder(SettingsManager settingsManager, DateEntityHelper dateEntityHelper, UserEntityHelper userEntityHelper) Deprecated. since 4.3. DateEntityFactory replaces DateEntityHelper.

Method Summary

Modifier and Type	Method and Description
SearchResultEntity	build(SearchResult result) Builds a REST ContentEntity for the given search result
SearchResultEntity	build(SearchResult result) Builds a REST ContentEntity for the given search result
ContentEntity	build(T object) Builds a REST ContentEntity for the given CEO
static SpaceEntity	createSpaceEntity(Space space)

Methods inherited from class java.lang.Object

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

Field Detail

settingsManager

protected final SettingsManager settingsManager

Constructor Detail

DefaultContentEntityBuilder

@Deprecated
public DefaultContentEntityBuilder(SettingsManager settingsManager,
                                               DateEntityHelper dateEntityHelper,
                                               UserEntityHelper userEntityHelper)

Deprecated. since 4.3. DateEntityFactory replaces DateEntityHelper.

Parameters:

settingsManager -

dateEntityHelper -

userEntityHelper -

DefaultContentEntityBuilder

public DefaultContentEntityBuilder(SettingsManager settingsManager,
                                   DateEntityFactory dateEntityFactory,
                                   UserEntityHelper userEntityHelper)

Method Detail

build

public SearchResultEntity build(SearchResult result)

Description copied from interface: SearchEntityBuilder

Builds a REST ContentEntity for the given search result

Specified by:

build in interface SearchEntityBuilder

Parameters:

result - the SearchResult

Returns:

the entity, or null if the current user is not permitted to view the content or if no content object can be found for the given result.

build

public SearchResultEntity build(SearchResult result)

Description copied from interface: SearchEntityBuilder

Builds a REST ContentEntity for the given search result

Specified by:

build in interface SearchEntityBuilder

Parameters:

result - the SearchResult

Returns:

the entity, or null if the current user is not permitted to view the content or if no content object can be found for the given result.

build

public ContentEntity build(T object)

Description copied from interface: ContentEntityBuilder

Builds a REST ContentEntity for the given CEO

Specified by:

build in interface ContentEntityBuilder<T extends ContentEntityObject>

Parameters:

object - the ContentEntityObject

Returns:

the entity, or null if the current user is not permitted to view the content or if no content object can be found for the given object.

createSpaceEntity

public static SpaceEntity createSpaceEntity(Space space)