Package org.xwiki.filter.xar.input

Class XARInputProperties

java.lang.Object

org.xwiki.filter.DefaultFilterStreamProperties

org.xwiki.filter.xml.XMLProperties

org.xwiki.filter.xml.input.XMLInputProperties

org.xwiki.filter.xar.input.XARInputProperties

All Implemented Interfaces:

org.xwiki.filter.FilterStreamProperties

public class XARInputProperties
extends org.xwiki.filter.xml.input.XMLInputProperties

XAR input properties.

Since:

6.2M1

Version:

$Id: a9f94893d04801ce0ad94e39b1b052a5ea5408bc $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XARInputProperties.SourceType	The type of the InputSource.

Field Summary

Fields inherited from interface org.xwiki.filter.FilterStreamProperties

PROPNAME_VERBOSE

Constructor Summary

Constructors

Constructor	Description
XARInputProperties()

Method Summary

Modifier and Type	Method	Description
org.xwiki.model.reference.EntityReferenceSet	getEntities()
String	getObjectPropertyType()
XARInputProperties.SourceType	getSourceType()
boolean	isForceDocument()	Deprecated. since 9.0RC1, use getSourceType() instead
boolean	isWithExtension()
boolean	isWithHistory()
void	setEntities(org.xwiki.model.reference.EntityReferenceSet entities)
void	setForceDocument(boolean forceDocument)	Deprecated. since 9.0RC1, use setSourceType(SourceType) instead
void	setObjectPropertyType(String objectPropertyType)
void	setSourceType(XARInputProperties.SourceType sourceType)
void	setWithExtension(boolean withExtension)
void	setWithHistory(boolean withHistory)

Methods inherited from class org.xwiki.filter.xml.input.XMLInputProperties

getEncoding, getSource, setEncoding, setSource

Methods inherited from class org.xwiki.filter.DefaultFilterStreamProperties

isVerbose, setVerbose

Methods inherited from class java.lang.Object

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

Constructor Detail

XARInputProperties

public XARInputProperties()

Method Detail

getEntities

public org.xwiki.model.reference.EntityReferenceSet getEntities()

Returns:

The entities to take into account or skip

setEntities

public void setEntities(org.xwiki.model.reference.EntityReferenceSet entities)

Parameters:

entities - The entities to take into account or skip

isWithHistory

public boolean isWithHistory()

Returns:

Indicate if events should be generated for history

setWithHistory

public void setWithHistory(boolean withHistory)

Parameters:

withHistory - Indicate if events should be generated for history

getSourceType

public XARInputProperties.SourceType getSourceType()

Returns:

the type of the source

Since:

9.0RC1

setSourceType

public void setSourceType(XARInputProperties.SourceType sourceType)

Parameters:

sourceType - the type of the source

Since:

9.0RC1

isForceDocument

@Deprecated
public boolean isForceDocument()

Deprecated.

since 9.0RC1, use getSourceType() instead

Returns:

true if the input should be forced as document

setForceDocument

@Deprecated
public void setForceDocument(boolean forceDocument)

Deprecated.

since 9.0RC1, use setSourceType(SourceType) instead

Parameters:

forceDocument - true if the input should be forced as document

isWithExtension

public boolean isWithExtension()

Returns:

true indicates if extension event should be generated if possible

Since:

6.2M1

setWithExtension

public void setWithExtension(boolean withExtension)

Parameters:

withExtension - indicates if extension event should be generated if possible

Since:

6.2M1

getObjectPropertyType

public String getObjectPropertyType()

Returns:

the type of the object property to parse

Since:

9.0RC1

setObjectPropertyType

public void setObjectPropertyType(String objectPropertyType)

Parameters:

objectPropertyType - the type of the object property to parse

Since:

9.0RC1