de.intarsys.pdf.cos

Interface ICOSContainer

All Known Implementing Classes:

COSArray, COSCompositeObject, COSDictionary, COSDocument, COSIndirectObject, COSObjectProxy, COSStream

public interface ICOSContainer

A low level interface for polymorphic access to an object containing a COSObject.

This is implemented for example by COSArray.

Method Summary

Methods

Modifier and Type	Method and Description
ICOSContainer	associate(ICOSContainer newContainer, COSObject object) It is the responsibility of the current container to create the association with the new one.
COSDocumentElement	containable(COSObject object) The stand-in to be used when object should be contained in a container.
ICOSContainer	disassociate(ICOSContainer oldContainer, COSObject object) It is the responsibility of the current container to remove the association from the old one.
COSDocument	getDoc() The COSDocument instance where the ICOSContainer is contained.
void	harden(COSObject object) "Harden" the reference to object, keeping it from being garbage collected even if (temporarily) not accessed.
int	referenceCount() The number of references to the contained object.
COSIndirectObject	referenceIndirect(COSObject object) Switch a contained object to an indirect one.
void	register(COSDocumentElement object) It is the responsibility of the active container to register object in its data structures.
ICOSContainer	restoreStateContainer(ICOSContainer container) Restore the save state for the container.
ICOSContainer	saveStateContainer() Create a save state for the container when saving the COSObject state.
void	soften(COSObject object) "Soften" the reference to object, making it accessible for swapping out / garbage collection if the counter for hardening is zero.
void	willChange(COSObject object) Propagate a change from a COSObject down in the hierarchy.

Method Detail

associate

ICOSContainer associate(ICOSContainer newContainer,
                      COSObject object)

It is the responsibility of the current container to create the association with the new one. The table shows the available transitions | composite | indirect | | constant | n.a. | n.a. | (always copied before by "containable") null | ok | ok | composite | error | ok | indirect | ok | ok |

Parameters:

newContainer -

object -

Returns:

The resulting ICOSContainer for object

containable

COSDocumentElement containable(COSObject object)

The stand-in to be used when object should be contained in a container. This is either the object itself or the COSIndirectObject to it.

Parameters:

object - THe object whose containable is requested.

Returns:

The stand-in to be used when object should be contained in a container.

disassociate

ICOSContainer disassociate(ICOSContainer oldContainer,
                         COSObject object)

It is the responsibility of the current container to remove the association from the old one. The table shows the available transitions.

              | composite  | indirect   |
              |
    constant  | n.a.       | n.a.       |
    null      | n.a.       | n.a.       |
    composite | ok         | n.a.       |
    indirect  | ok         | n.a.       |
 

Parameters:

oldContainer -

object -

Returns:

The resulting ICOSContainer for object

getDoc

COSDocument getDoc()

The COSDocument instance where the ICOSContainer is contained.

Returns:

The COSDocument instance where the ICOSContainer is contained.

harden

void harden(COSObject object)

"Harden" the reference to object, keeping it from being garbage collected even if (temporarily) not accessed. Otherwise a container may decide to "swap" its descendants out of memory.

Hardening uses a counter to decide if a strong reference can be finally released.

Parameters:

object - The object that should be kept in memory.

referenceCount

int referenceCount()

The number of references to the contained object. This method returns -1 when the value can not be determined (as for indirect objects parsed from a file).

Returns:

The number of references to the contained object.

referenceIndirect

COSIndirectObject referenceIndirect(COSObject object)

Switch a contained object to an indirect one. Update the reference.

Parameters:

object - The object to be indirect

register

void register(COSDocumentElement object)

It is the responsibility of the active container to register object in its data structures.

Parameters:

object - The new object to be registered in the hierarchy.

restoreStateContainer

ICOSContainer restoreStateContainer(ICOSContainer container)

Restore the save state for the container.

Parameters:

container -

Returns:

The "before" state of the receiver.

saveStateContainer

ICOSContainer saveStateContainer()

Create a save state for the container when saving the COSObject state.

Returns:

The save state for the container.

soften

void soften(COSObject object)

"Soften" the reference to object, making it accessible for swapping out / garbage collection if the counter for hardening is zero.

Parameters:

object - The object that should be kept in memory.

willChange

void willChange(COSObject object)

Propagate a change from a COSObject down in the hierarchy.