Package com.atlassian.confluence.plugins.contentproperty

Class JsonPropertyEntityAdapter

java.lang.Object

com.atlassian.confluence.content.ContentEntityAdapterParent

com.atlassian.confluence.plugins.contentproperty.JsonPropertyEntityAdapter

All Implemented Interfaces:

ContentEntityAdapter

public class JsonPropertyEntityAdapter
extends ContentEntityAdapterParent

Adapter for content properties.

Since:

5.6

Constructor Summary

Constructors

Constructor	Description
JsonPropertyEntityAdapter()

Method Summary

Modifier and Type	Method	Description
BodyType	getDefaultBodyType(CustomContentEntityObject pluginContentEntityObject)	Get the default type for BodyContent objects attached to this content.
boolean	isAllowedContainer(ContentEntityObject child, ContentEntityObject container)	Determine if a particular content is an acceptable container for a particular child.
static boolean	isContentProperty(CustomContentEntityObject o)
static boolean	isContentProperty(ContentEntityObject o)
boolean	isIndexable(CustomContentEntityObject pluginContentEntityObject, boolean isDefaultIndexable)	Determine if a particular content should be indexed.

Methods inherited from class com.atlassian.confluence.content.ContentEntityAdapterParent

attachmentsUrlPath, attachmentUrlPath, displayTitle, excerpt, getVersionChildPolicy, isAllowedParent, nameForComparison, shouldConvertToContent, urlPath

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.content.ContentEntityAdapter

getAttachmentsUrlPath, getAttachmentUrlPath, getDisplayTitle, getExcerpt, getNameForComparison, getUrlPath

Constructor Detail

JsonPropertyEntityAdapter

public JsonPropertyEntityAdapter()

Method Detail

isContentProperty

public static boolean isContentProperty(ContentEntityObject o)

isContentProperty

public static boolean isContentProperty(CustomContentEntityObject o)

getDefaultBodyType

public BodyType getDefaultBodyType(CustomContentEntityObject pluginContentEntityObject)

Description copied from interface: ContentEntityAdapter

Get the default type for BodyContent objects attached to this content.

Specified by:

getDefaultBodyType in interface ContentEntityAdapter

Overrides:

getDefaultBodyType in class ContentEntityAdapterParent

Parameters:

pluginContentEntityObject - the content to get the body type of

Returns:

the default BodyType for that content

isAllowedContainer

public boolean isAllowedContainer(ContentEntityObject child,
                                  ContentEntityObject container)

Description copied from interface: ContentEntityAdapter

Determine if a particular content is an acceptable container for a particular child. The content object will ensure that there are no loops in the container/child chain, and that the container is in the same space as the child (if any), so implementations do not need to check that.

Will be invoked for the child adapter and the container adapter, if applicable.

Only one of container or child are required to be CustomContentEntityObjects. If both types are CustomContentEntityObjects, this must only be used if CustomContentEntityObject.getPluginModuleKey() also returns distinct values for both objects.

Specified by:

isAllowedContainer in interface ContentEntityAdapter

Overrides:

isAllowedContainer in class ContentEntityAdapterParent

See Also:

ContentEntityAdapter.isAllowedParent(CustomContentEntityObject, CustomContentEntityObject)

isIndexable

public boolean isIndexable(CustomContentEntityObject pluginContentEntityObject,
                           boolean isDefaultIndexable)

Description copied from interface: ContentEntityAdapter

Determine if a particular content should be indexed. The isDefaultIndexable parameter will contain the value of super.isIndexable(), so the plugin may choose to follow or override the standard reasons not to index SpaceContentEntityObject (trashed content, content that is not in a space, content that is an old version are all not indexed by default)

Specified by:

isIndexable in interface ContentEntityAdapter

Overrides:

isIndexable in class ContentEntityAdapterParent

Parameters:

pluginContentEntityObject - the entity to check

isDefaultIndexable - if the entity would be indexed absent of this check.