Package org.xwiki.filter.instance.input

Class DocumentInstanceInputProperties

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

org.xwiki.filter.instance.input.InstanceInputProperties

org.xwiki.filter.instance.input.DocumentInstanceInputProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, org.xwiki.filter.FilterStreamProperties, org.xwiki.properties.RawProperties

public class DocumentInstanceInputProperties
extends InstanceInputProperties

Since:

6.2M1

Version:

$Id: fcc1ca2eb6cdf1df3f2a976a267a453c4b898a72 $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields inherited from interface org.xwiki.filter.FilterStreamProperties

PROPNAME_VERBOSE

Constructor Summary

Constructors

Constructor	Description
DocumentInstanceInputProperties()

Method Summary

Modifier and Type	Method	Description
Set<String>	getAttachmentsContent()
boolean	isWithJRCSRevisions()
boolean	isWithRevisions()
boolean	isWithWikiAttachmentJRCSRevisions()
boolean	isWithWikiAttachments()
boolean	isWithWikiAttachmentsContent()
boolean	isWithWikiAttachmentsRevisions()
boolean	isWithWikiClass()
boolean	isWithWikiDocumentContentHTML()
boolean	isWithWikiObjects()
void	setAttachmentsContent(Set<String> attachmentsContent)
void	setWithJRCSRevisions(boolean withJRCSRevisions)
void	setWithRevisions(boolean withRevisions)
void	setWithWikiAttachmentJRCSRevisions(boolean withWikiAttachmentJRCSRevisions)
void	setWithWikiAttachments(boolean withWikiAttachments)
void	setWithWikiAttachmentsContent(boolean withWikiAttachmentsContent)
void	setWithWikiAttachmentsRevisions(boolean withWikiAttachmentsRevisions)
void	setWithWikiClass(boolean withWikiClass)
void	setWithWikiDocumentContentHTML(boolean withWikiDocumentContentHTML)
void	setWithWikiObjects(boolean withWikiObjects)

Methods inherited from class org.xwiki.filter.instance.input.InstanceInputProperties

getEntities, isVerbose, set, setEntities, setVerbose

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

DocumentInstanceInputProperties

public DocumentInstanceInputProperties()

Method Detail

isWithRevisions

public boolean isWithRevisions()

Returns:

Indicates if events should be generated for history

setWithRevisions

public void setWithRevisions(boolean withRevisions)

Parameters:

withRevisions - Indicates if events should be generated for history

isWithJRCSRevisions

public boolean isWithJRCSRevisions()

Returns:

Indicates if JRCS based history should be added to document locale event properties

setWithJRCSRevisions

public void setWithJRCSRevisions(boolean withJRCSRevisions)

Parameters:

withJRCSRevisions - Indicates if JRCS based history should be added to document locale event properties

isWithWikiAttachments

public boolean isWithWikiAttachments()

Returns:

Indicate if events should be generated for attachments

setWithWikiAttachments

public void setWithWikiAttachments(boolean withWikiAttachments)

Parameters:

withWikiAttachments - Indicate if events should be generated for attachments

isWithWikiAttachmentsContent

public boolean isWithWikiAttachmentsContent()

Returns:

Indicate if events should be generated for attachments content

Since:

9.0RC1

setWithWikiAttachmentsContent

public void setWithWikiAttachmentsContent(boolean withWikiAttachmentsContent)

Parameters:

withWikiAttachmentsContent - Indicate if events should be generated for attachments content

Since:

9.0RC1

getAttachmentsContent

public Set<String> getAttachmentsContent()

Returns:

the attachments for which to generate content events

Since:

13.8RC1

setAttachmentsContent

public void setAttachmentsContent(Set<String> attachmentsContent)

Parameters:

attachmentsContent - the attachments for which to generate content events

Since:

13.8RC1

isWithWikiAttachmentsRevisions

public boolean isWithWikiAttachmentsRevisions()

Returns:

Indicate if events should be generated for attachments revisions

Since:

12.0RC1

setWithWikiAttachmentsRevisions

public void setWithWikiAttachmentsRevisions(boolean withWikiAttachmentsRevisions)

Parameters:

withWikiAttachmentsRevisions - Indicate if events should be generated for attachments revisions

Since:

12.0RC1

isWithWikiAttachmentJRCSRevisions

public boolean isWithWikiAttachmentJRCSRevisions()

Returns:

Indicates if JRCS based history should be added to attachment event properties

setWithWikiAttachmentJRCSRevisions

public void setWithWikiAttachmentJRCSRevisions(boolean withWikiAttachmentJRCSRevisions)

Parameters:

withWikiAttachmentJRCSRevisions - Indicates if JRCS based history should be added to attachment event properties

isWithWikiClass

public boolean isWithWikiClass()

Returns:

Indicate if events should be generated for classes

setWithWikiClass

public void setWithWikiClass(boolean withWikiClass)

Parameters:

withWikiClass - Indicate if events should be generated for classes

isWithWikiObjects

public boolean isWithWikiObjects()

Returns:

Indicate if events should be generated for objects

setWithWikiObjects

public void setWithWikiObjects(boolean withWikiObjects)

Parameters:

withWikiObjects - Indicate if events should be generated for objects

isWithWikiDocumentContentHTML

public boolean isWithWikiDocumentContentHTML()

Returns:

Indicate if events should be generated for document content as HTML

setWithWikiDocumentContentHTML

public void setWithWikiDocumentContentHTML(boolean withWikiDocumentContentHTML)

Parameters:

withWikiDocumentContentHTML - Indicate if events should be generated for document content as HTML