Package org.apache.pdfbox.cos

Class COSUpdateState

java.lang.Object

org.apache.pdfbox.cos.COSUpdateState

public class COSUpdateState
extends Object

A COSUpdateState instance manages update states for a COSUpdateInfo. Such states are used to create a COSIncrement for the incremental saving of a COSDocument.

See Also:

• COSDocumentState
• COSUpdateInfo
• COSIncrement

Field Summary

Fields

Modifier and Type	Field	Description
private COSDocumentState	originDocumentState	The COSDocumentState the updateInfo is linked to.
private boolean	updated	The actual update state of updateInfo.
private final COSUpdateInfo	updateInfo	The COSUpdateInfo the COSUpdateState does manage update states for.

Constructor Summary

Constructors

Constructor	Description
COSUpdateState(COSUpdateInfo updateInfo)	Creates a new COSUpdateState for the given COSUpdateInfo.

Method Summary

Modifier and Type	Method	Description
(package private) void	dereferenceChild(COSBase child)	This shall setOriginDocumentState(COSDocumentState, boolean) for the dereferenced child, initializing its originDocumentState.
COSDocumentState	getOriginDocumentState()	Returns the originDocumentState, that is linked to the managed updateInfo.
(package private) boolean	isAcceptingUpdates()	Returns true, if the linked originDocumentState COSDocumentState.isAcceptingUpdates() and such a COSDocumentState has been linked to this COSUpdateState.
boolean	isUpdated()	Returns the actual updated state of the managed updateInfo.
void	setOriginDocumentState(COSDocumentState originDocumentState)	Links the given COSDocumentState to the updated state of the managed updateInfo.
private void	setOriginDocumentState(COSDocumentState originDocumentState, boolean dereferencing)	Links the given COSDocumentState to the updated state of the managed updateInfo.
(package private) COSIncrement	toIncrement()	Uses the managed updateInfo as the base object of a new COSIncrement.
(package private) void	update()	Calls update(boolean) with true as the new update state. This shall only then have an effect, if isAcceptingUpdates() returns true.
(package private) void	update(boolean updated)	Sets the updated state of the managed updateInfo to the given state. This shall only then have an effect, if isAcceptingUpdates() returns true.
(package private) void	update(Iterable<COSBase> children)	Shall call update() for this COSUpdateState and shall setOriginDocumentState(COSDocumentState) for the given children, initializing their updated state and originDocumentState.
(package private) void	update(COSArray children)	Shall call update() for this COSUpdateState and shall setOriginDocumentState(COSDocumentState) for the given children, initializing their updated state and originDocumentState.
(package private) void	update(COSBase child)	Shall call update() for this COSUpdateState and shall setOriginDocumentState(COSDocumentState) for the given child, initializing it´s updated state and originDocumentState.

Methods inherited from class java.lang.Object

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

Field Details

updateInfo

private final COSUpdateInfo updateInfo

The COSUpdateInfo the COSUpdateState does manage update states for.

originDocumentState

private COSDocumentState originDocumentState

The COSDocumentState the updateInfo is linked to.

updated

private boolean updated

The actual update state of updateInfo.

• true, if updateInfo has been updated after the document completed parsing.
• false, if updateInfo has remained unaltered since the document completed parsing.

Constructor Details

COSUpdateState

public COSUpdateState(COSUpdateInfo updateInfo)

Creates a new COSUpdateState for the given COSUpdateInfo.

Parameters:

updateInfo - The COSUpdateInfo, that shall be managed by this COSUpdateState.

Method Details

setOriginDocumentState

public void setOriginDocumentState(COSDocumentState originDocumentState)

Links the given COSDocumentState to the updated state of the managed updateInfo.

This shall also initialize updated accordingly and will also set the same COSDocumentState for all possibly contained substructures.

Should originDocumentState already have been set, by a prior call to this method, this shall deny to overwrite it.

COSDocumentState.isAcceptingUpdates() shall determine, whether updates to updateInfo are allowed.

As long as no COSDocumentState is linked to this COSUpdateState, it shall not accept updates.

Parameters:

originDocumentState - The COSDocumentState that shall be linked to this COSUpdateState.

See Also:

• originDocumentState
• updated

setOriginDocumentState

private void setOriginDocumentState(COSDocumentState originDocumentState,
 boolean dereferencing)

Links the given COSDocumentState to the updated state of the managed updateInfo.

This shall also initialize updated accordingly and will also set the same COSDocumentState for all possibly contained substructures.

Should originDocumentState already have been set, by a prior call to this method, this shall deny to overwrite it.

COSDocumentState.isAcceptingUpdates() shall determine, whether updates to updateInfo are allowed.

As long as no COSDocumentState is linked to this COSUpdateState, it shall not accept updates.

Additionally to setOriginDocumentState(COSDocumentState), this shall also deny changing updated, should the flag dereferencing indicate, that this is caused by dereferencing a COSObject.

Parameters:

originDocumentState - The COSDocumentState that shall be linked to this COSUpdateState.

dereferencing - true, if this update of the COSDocumentState is caused by dereferencing a COSObject.

See Also:

• originDocumentState
• updated

getOriginDocumentState

public COSDocumentState getOriginDocumentState()

Returns the originDocumentState, that is linked to the managed updateInfo.

COSDocumentState.isAcceptingUpdates() shall determine, whether updates to updateInfo are allowed.

As long as no COSDocumentState is linked to this COSUpdateState, it shall not accept updates.

Returns:

The COSDocumentState linked to this COSUpdateState.

See Also:

• setOriginDocumentState(COSDocumentState)

isAcceptingUpdates

boolean isAcceptingUpdates()

Returns true, if the linked originDocumentState COSDocumentState.isAcceptingUpdates() and such a COSDocumentState has been linked to this COSUpdateState.

Returns:

true, if the linked originDocumentState COSDocumentState.isAcceptingUpdates() and such a COSDocumentState has been linked to this COSUpdateState.

See Also:

• originDocumentState
• COSDocumentState.isAcceptingUpdates()

isUpdated

public boolean isUpdated()

Returns the actual updated state of the managed updateInfo.

Returns:

The actual updated state of the managed updateInfo

See Also:

• updated

update

void update()

Calls update(boolean) with true as the new update state.
This shall only then have an effect, if isAcceptingUpdates() returns true.

See Also:

• update(boolean)
• updated
• isAcceptingUpdates()

update

void update(boolean updated)

Sets the updated state of the managed updateInfo to the given state.
This shall only then have an effect, if isAcceptingUpdates() returns true.

Parameters:

updated - The state to set for updated.

See Also:

• update(boolean)
• updated
• isAcceptingUpdates()

update

void update(COSBase child)

Shall call update() for this COSUpdateState and shall setOriginDocumentState(COSDocumentState) for the given child, initializing it´s updated state and originDocumentState.

This shall have no effect for a child, that is not an instance of COSUpdateInfo.

Parameters:

child - The child that shall also be updated.

See Also:

• update()
• setOriginDocumentState(COSDocumentState)

update

void update(COSArray children)

Shall call update() for this COSUpdateState and shall setOriginDocumentState(COSDocumentState) for the given children, initializing their updated state and originDocumentState.

This shall have no effect for a child, that is not an instance of COSUpdateInfo.

Parameters:

children - The children that shall also be updated.

See Also:

• update()
• setOriginDocumentState(COSDocumentState)

update

void update(Iterable<COSBase> children)

Shall call update() for this COSUpdateState and shall setOriginDocumentState(COSDocumentState) for the given children, initializing their updated state and originDocumentState.

This shall have no effect for a child, that is not an instance of COSUpdateInfo.

Parameters:

children - The children that shall also be updated.

See Also:

• update()
• setOriginDocumentState(COSDocumentState)

dereferenceChild

void dereferenceChild(COSBase child)

This shall setOriginDocumentState(COSDocumentState, boolean) for the dereferenced child, initializing its originDocumentState.

This shall have no effect for a child, that is not an instance of COSUpdateInfo and will never change the child´s updated state.

Parameters:

child - The child, that has been dereferenced.

See Also:

• setOriginDocumentState(COSDocumentState, boolean)

toIncrement

COSIncrement toIncrement()

Uses the managed updateInfo as the base object of a new COSIncrement.

Returns:

A COSIncrement based on the managed updateInfo.

See Also:

• COSUpdateInfo
• COSIncrement