Top Methods
org.apache.pdfbox.cos

public Interface COSUpdateInfo

extends COSObjectable
Known Direct Implementers
org.apache.pdfbox.cos.COSArray, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.cos.COSObject
Imports
org.apache.pdfbox.pdmodel.common.COSObjectable

Method Summary

Modifier and TypeMethod and Description
public COSUpdateState

Returns:

The current COSUpdateState of this COSUpdateInfo.
getUpdateState()

Returns the current COSUpdateState of this COSUpdateInfo.

public default boolean

Returns:

the update state.
isNeedToBeUpdated()

Get the update state for the COSWriter.

public default void
setNeedToBeUpdated(boolean
the update state.
flag)

Set the update state of the dictionary for the COSWriter.

public default COSIncrement

Returns:

A COSIncrement based on this COSUpdateInfo.
toIncrement()

Uses this COSUpdateInfo as the base object of a new COSIncrement.

Inherited from org.apache.pdfbox.pdmodel.common.COSObjectable:
getCOSObject

Method Detail

getUpdateStateback to summary
public COSUpdateState getUpdateState()

Returns the current COSUpdateState of this COSUpdateInfo.

Returns:COSUpdateState

The current COSUpdateState of this COSUpdateInfo.

See Also
COSUpdateState
isNeedToBeUpdatedback to summary
public default boolean isNeedToBeUpdated()

Get the update state for the COSWriter. This indicates whether an object is to be written when there is an incremental save.

Returns:boolean

the update state.

setNeedToBeUpdatedback to summary
public default void setNeedToBeUpdated(boolean flag)

Set the update state of the dictionary for the COSWriter. This indicates whether an object is to be written when there is an incremental save.

Parameters
flag:boolean

the update state.

toIncrementback to summary
public default COSIncrement toIncrement()

Uses this COSUpdateInfo as the base object of a new COSIncrement.

Returns:COSIncrement

A COSIncrement based on this COSUpdateInfo.

See Also
COSIncrement