Apache PDFBox 3.0.4 · org.apache.pdfbox.cos.COSUpdateState

Modifier and Type	Field and 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.

Access	Constructor and Description
public	COSUpdateState(COSUpdateInfo The `COSUpdateInfo`, that shall be managed by this `COSUpdateState`. updateInfo) Creates a new `COSUpdateState` for the given `COSUpdateInfo`.

Method Summary

Modifier and Type	Method and Description
pack-priv void	dereferenceChild(COSBase The child, that has been dereferenced. child) This shall `setOriginDocumentState(COSDocumentState, boolean)` for the dereferenced child, initializing its `originDocumentState`.
public COSDocumentState	Returns: The `COSDocumentState` linked to this `COSUpdateState`. getOriginDocumentState() Returns the `originDocumentState`, that is linked to the managed `updateInfo`.
pack-priv boolean	Returns: `true`, if the linked `originDocumentState` `COSDocumentState#isAcceptingUpdates()` and such a `COSDocumentState` has been linked to this `COSUpdateState`. isAcceptingUpdates() Returns `true`, if the linked `originDocumentState` `COSDocumentState#isAcceptingUpdates()` and such a `COSDocumentState` has been linked to this `COSUpdateState`.
public boolean	Returns: The actual `updated` state of the managed `updateInfo` isUpdated() Returns the actual `updated` state of the managed `updateInfo`.
public void	setOriginDocumentState(COSDocumentState The `COSDocumentState` that shall be linked to this `COSUpdateState`. originDocumentState) Links the given `COSDocumentState` to the `updated` state of the managed `updateInfo`.
private void	setOriginDocumentState(COSDocumentState The `COSDocumentState` that shall be linked to this `COSUpdateState`. originDocumentState, boolean `true`, if this update of the `COSDocumentState` is caused by dereferencing a `COSObject`. dereferencing) Links the given `COSDocumentState` to the `updated` state of the managed `updateInfo`.
pack-priv COSIncrement	Returns: A `COSIncrement` based on the managed `updateInfo`. toIncrement() Uses the managed `updateInfo` as the base object of a new `COSIncrement`.
pack-priv void	update() Calls `update(boolean)` with `true` as the new update state.
pack-priv void	update(boolean The state to set for `updated`. updated) Sets the `updated` state of the managed `updateInfo` to the given state.
pack-priv void	update(COSBase The child that shall also be updated. child) Shall call `update()` for this `COSUpdateState` and shall `setOriginDocumentState(COSDocumentState)` for the given child, initializing it´s `updated` state and `originDocumentState`.
pack-priv void	update(COSArray The children that shall also be updated. children) Shall call `update()` for this `COSUpdateState` and shall `setOriginDocumentState(COSDocumentState)` for the given children, initializing their `updated` state and `originDocumentState`.
pack-priv void	update(Iterable<COSBase> The children that shall also be updated. children) Shall call `update()` for this `COSUpdateState` and shall `setOriginDocumentState(COSDocumentState)` for the given children, initializing their `updated` state and `originDocumentState`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

originDocumentState	back to summary
private COSDocumentState originDocumentState The `COSDocumentState` the `updateInfo` is linked to.

updated	back to summary
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.

updateInfo	back to summary
private final COSUpdateInfo updateInfo The `COSUpdateInfo` the `COSUpdateState` does manage update states for.

COSUpdateState	back to summary
public COSUpdateState(COSUpdateInfo updateInfo) Creates a new `COSUpdateState` for the given `COSUpdateInfo`. Parameters updateInfo:COSUpdateInfo The `COSUpdateInfo`, that shall be managed by this `COSUpdateState`.

Method Detail

dereferenceChild back to summary

dereferenceChild	back to summary
pack-priv 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:COSBase The child, that has been dereferenced. See Also `setOriginDocumentState(COSDocumentState, boolean)`

pack-priv 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:COSBase: The child, that has been dereferenced.

getOriginDocumentState back to summary

getOriginDocumentState	back to summary
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:COSDocumentState The `COSDocumentState` linked to this `COSUpdateState`. See Also `setOriginDocumentState(COSDocumentState)`

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:COSDocumentState: The COSDocumentState linked to this COSUpdateState.
See Also: setOriginDocumentState(COSDocumentState)

isAcceptingUpdates back to summary

isAcceptingUpdates	back to summary
pack-priv boolean isAcceptingUpdates() Returns `true`, if the linked `originDocumentState` `COSDocumentState#isAcceptingUpdates()` and such a `COSDocumentState` has been linked to this `COSUpdateState`. Returns:boolean `true`, if the linked `originDocumentState` `COSDocumentState#isAcceptingUpdates()` and such a `COSDocumentState` has been linked to this `COSUpdateState`. See Also `originDocumentState`, `COSDocumentState#isAcceptingUpdates()`

pack-priv boolean isAcceptingUpdates()

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

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

isUpdated back to summary

isUpdated	back to summary
public boolean isUpdated() Returns the actual `updated` state of the managed `updateInfo`. Returns:boolean The actual `updated` state of the managed `updateInfo` See Also `updated`

public boolean isUpdated()

Returns the actual updated state of the managed updateInfo.

Returns:boolean: The actual updated state of the managed updateInfo
See Also: updated

setOriginDocumentState back to summary

setOriginDocumentState	back to summary
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:COSDocumentState The `COSDocumentState` that shall be linked to this `COSUpdateState`. See Also `originDocumentState`, `updated`

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:COSDocumentState: The COSDocumentState that shall be linked to this COSUpdateState.

See Also

originDocumentState, updated

setOriginDocumentState back to summary

setOriginDocumentState	back to summary
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:COSDocumentState The `COSDocumentState` that shall be linked to this `COSUpdateState`. dereferencing:boolean `true`, if this update of the `COSDocumentState` is caused by dereferencing a `COSObject`. See Also `originDocumentState`, `updated`

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:COSDocumentState: The COSDocumentState that shall be linked to this COSUpdateState.
dereferencing:boolean: true, if this update of the COSDocumentState is caused by dereferencing a COSObject.

See Also

originDocumentState, updated

toIncrement back to summary

toIncrement	back to summary
pack-priv COSIncrement toIncrement() Uses the managed `updateInfo` as the base object of a new `COSIncrement`. Returns:COSIncrement A `COSIncrement` based on the managed `updateInfo`. See Also `COSUpdateInfo`, `COSIncrement`

pack-priv COSIncrement toIncrement()

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

Returns:COSIncrement: A COSIncrement based on the managed updateInfo.
See Also: COSUpdateInfo, COSIncrement

update back to summary

update	back to summary
pack-priv 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()`

pack-priv 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 back to summary

update	back to summary
pack-priv 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:boolean The state to set for `updated`. See Also `update(boolean)`, `updated`, `isAcceptingUpdates()`

pack-priv 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:boolean: The state to set for updated.

update back to summary

update	back to summary
pack-priv 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:COSBase The child that shall also be updated. See Also `update()`, `setOriginDocumentState(COSDocumentState)`

pack-priv 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:COSBase: The child that shall also be updated.

update back to summary

update	back to summary
pack-priv 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:COSArray The children that shall also be updated. See Also `update()`, `setOriginDocumentState(COSDocumentState)`

pack-priv 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:COSArray: The children that shall also be updated.

update back to summary

update	back to summary
pack-priv 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:Iterable<COSBase> The children that shall also be updated. See Also `update()`, `setOriginDocumentState(COSDocumentState)`

pack-priv 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:Iterable<COSBase>: The children that shall also be updated.

public Class COSUpdateState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail