Package org.docx4j.openpackaging.parts

Class DocPropsCustomPart

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.parts.Part

org.docx4j.openpackaging.parts.JaxbXmlPart<Properties>

org.docx4j.openpackaging.parts.DocPropsCustomPart

public class DocPropsCustomPart
extends JaxbXmlPart<Properties>

Author:

jharrop

Field Summary

Fields

Modifier and Type	Field	Description
static final String	fmtidValLpwstr
static final String	MARK_AS_FINAL

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

jaxbElement, jc, MAX_BYTES_Unmarshal_Error

Fields inherited from class org.docx4j.openpackaging.parts.Part

pack

Fields inherited from class org.docx4j.openpackaging.Base

contentType, partName, relationships

Constructor Summary

Constructors

Constructor	Description
DocPropsCustomPart()
DocPropsCustomPart(PartName partName)

Method Summary

Modifier and Type	Method	Description
boolean	getMarkAsFinal()
int	getNextPid()	Find the first available Pid
Properties.Property	getProperty(String propName)
void	init()
void	setMarkAsFinal(boolean val)
void	setProperty(String propName, boolean propValue)
void	setProperty(String propName, String propValue)
Properties	unmarshal(InputStream is)	Unmarshal XML data from the specified InputStream and return the resulting content tree.

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

addMcChoiceNamespace, getConfiguredUnmarshaller, getContents, getJAXBContext, getJaxbElement, getMcChoiceNamespaces, getMceIgnorable, getXML, inputStreamToXSR, isContentEqual, isUnmarshalled, marshal, marshal, marshal, marshal, pipe, pipe, pipe, preprocess, setContents, setJAXBContext, setJaxbElement, setJaxbElement, setMceIgnorable, transform, transformToDom, unmarshal, variableReplace

Methods inherited from class org.docx4j.openpackaging.parts.Part

getContentLengthAsLoaded, getOwningRelationshipPart, getPackage, getRelationshipType, getSourceRelationship, getSourceRelationships, getVersion, remove, rename, setContentLengthAsLoaded, setOwningRelationshipPart, setPackage, setPartShortcut, setRelationshipType, setSourceRelationship, setVersion

Methods inherited from class org.docx4j.openpackaging.Base

addTargetPart, addTargetPart, addTargetPart, addTargetPart, getContentType, getPartName, getRelationshipsPart, getRelationshipsPart, getUserData, reset, setContentType, setPartName, setRelationships, setUserData

Methods inherited from class java.lang.Object

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

Field Details

fmtidValLpwstr

public static final String fmtidValLpwstr

See Also:

• Constant Field Values

MARK_AS_FINAL

public static final String MARK_AS_FINAL

See Also:

• Constant Field Values

Constructor Details

DocPropsCustomPart

public DocPropsCustomPart(PartName partName)
                   throws InvalidFormatException

Throws:

InvalidFormatException

DocPropsCustomPart

public DocPropsCustomPart()
                   throws InvalidFormatException

Throws:

InvalidFormatException

Method Details

init

public void init()

unmarshal

public Properties unmarshal(InputStream is)
                     throws jakarta.xml.bind.JAXBException

Unmarshal XML data from the specified InputStream and return the resulting content tree. Validation event location information may be incomplete when using this form of the unmarshal API.

Implements Unmarshal Global Root Element.

Overrides:

unmarshal in class JaxbXmlPart<Properties>

Parameters:

is - the InputStream to unmarshal XML data from

Returns:

the newly created root object of the java content tree

Throws:

jakarta.xml.bind.JAXBException - If any unexpected errors occur while unmarshalling

getProperty

public Properties.Property getProperty(String propName)

setProperty

public void setProperty(String propName,
 String propValue)

setProperty

public void setProperty(String propName,
 boolean propValue)

Parameters:

propName -

propValue -

Since:

3.3.0

getNextPid

public int getNextPid()

Find the first available Pid

Returns:

getMarkAsFinal

public boolean getMarkAsFinal()

Since:

3.3.0

setMarkAsFinal

public void setMarkAsFinal(boolean val)

Since:

3.3.0