Package org.xwiki.filter.instance.output

Class DocumentInstanceOutputProperties

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

org.xwiki.filter.instance.output.InstanceOutputProperties

org.xwiki.filter.instance.output.DocumentInstanceOutputProperties

All Implemented Interfaces:

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

public class DocumentInstanceOutputProperties
extends InstanceOutputProperties

Since:

6.2M1

Version:

$Id: 5a9a9f3e889bad24a19dcb909118f6e77bb531a6 $

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
DocumentInstanceOutputProperties()

Method Summary

Modifier and Type	Method	Description
org.xwiki.model.reference.DocumentReference	getAuthor()
org.xwiki.model.reference.EntityReference	getDefaultReference()
org.xwiki.rendering.syntax.Syntax	getDefaultSyntax()
String	getSaveComment()
boolean	isAuthorPreserved()
boolean	isAuthorSet()
boolean	isPreviousDeleted()
boolean	isStoppedWhenSaveFail()
boolean	isVersionPreserved()
void	setAuthor(org.xwiki.model.reference.DocumentReference author)
void	setAuthorPreserved(boolean authorPreserved)
void	setDefaultReference(org.xwiki.model.reference.EntityReference defaultReference)
void	setDefaultSyntax(org.xwiki.rendering.syntax.Syntax defaultSyntax)
void	setPreviousDeleted(boolean previousDeleted)
void	setSaveComment(String saveComment)
void	setStoppedWhenSaveFail(boolean stoppedWhenSaveFail)
void	setVersionPreserved(boolean versionPreserved)

Methods inherited from class org.xwiki.filter.instance.output.InstanceOutputProperties

isVerbose, set, 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

DocumentInstanceOutputProperties

public DocumentInstanceOutputProperties()

Method Detail

getDefaultReference

public org.xwiki.model.reference.EntityReference getDefaultReference()

Returns:

The base reference to use to resolve reference from events

setDefaultReference

public void setDefaultReference(org.xwiki.model.reference.EntityReference defaultReference)

Parameters:

defaultReference - The base reference to use to resolve reference from events

getSaveComment

public String getSaveComment()

Returns:

The comment to set when saving a document

setSaveComment

public void setSaveComment(String saveComment)

Parameters:

saveComment - The comment to set when saving a document

getDefaultSyntax

public org.xwiki.rendering.syntax.Syntax getDefaultSyntax()

Returns:

The default syntax if not is provided in events

setDefaultSyntax

public void setDefaultSyntax(org.xwiki.rendering.syntax.Syntax defaultSyntax)

Parameters:

defaultSyntax - The default syntax if not is provided in events

isPreviousDeleted

public boolean isPreviousDeleted()

Returns:

Indicate if existing document should be deleted before importing the new one

setPreviousDeleted

public void setPreviousDeleted(boolean previousDeleted)

Parameters:

previousDeleted - Indicate if existing document should be deleted before importing the new one

isVersionPreserved

public boolean isVersionPreserved()

Returns:

Indicate if the versions coming from the events should be kept

setVersionPreserved

public void setVersionPreserved(boolean versionPreserved)

Parameters:

versionPreserved - Indicate if the versions coming from the events should be kept

getAuthor

public org.xwiki.model.reference.DocumentReference getAuthor()

Returns:

the author to use when saving documents

Since:

8.2

setAuthor

public void setAuthor(org.xwiki.model.reference.DocumentReference author)

Parameters:

author - the author to use when saving documents

Since:

8.2

isAuthorSet

public boolean isAuthorSet()

Returns:

true if the author have been explicitly set

Since:

8.2

isAuthorPreserved

public boolean isAuthorPreserved()

Returns:

true if the authors coming from the events should be kept.

setAuthorPreserved

public void setAuthorPreserved(boolean authorPreserved)

Parameters:

authorPreserved - indicate if the authors coming from the events should be kept. Not taken into account if setAuthor(DocumentReference) is used.

isStoppedWhenSaveFail

public boolean isStoppedWhenSaveFail()

Returns:

Indicate if an exception should be thrown if a document save fail.

Since:

6.2.6, 6.4.2

setStoppedWhenSaveFail

public void setStoppedWhenSaveFail(boolean stoppedWhenSaveFail)

Parameters:

stoppedWhenSaveFail - Indicate if an exception should be thrown if a document save fail.

Since:

6.2.6, 6.4.2