com.myscript.iink

Class ContentPackage

java.lang.Object

com.myscript.iink.ContentPackage

All Implemented Interfaces:

IAutoCloseable

public class ContentPackage
extends java.lang.Object
implements IAutoCloseable

A package stores the user content as a sorted collection of parts.

See Also:

ContentPart

Method Summary

Modifier and Type	Method and Description
ContentPart	clonePart(ContentPart part) Adds an existing part to this package.
void	close() Deletes native counterpart of this auto closable object
ContentPart	createPart(java.lang.String type) Appends a new part to this package.
void	extractObject(java.lang.String url, java.io.File file) Extracts an object from this package to a given file.
ParameterSet	getMetadata() Returns this package's metadata as a parameter set.
ContentPart	getPart(int index) Returns the part at the specified index.
ContentPart	getPart(java.lang.String id) Returns the specified part.
int	getPartCount() Returns the number of parts in this package.
int	indexOfPart(ContentPart part) Returns the index of a given part.
boolean	isClosed() Tells whether the close() method has been called.
void	removePart(ContentPart part) Removes the specified part.
void	save() Saves all ongoing modifications made to this package.
void	saveAs(java.io.File file) Saves all ongoing modifications made to this package, to a new file.
void	saveToTemp() Saves all ongoing modifications made to this package to a temporary folder.
void	setMetadata(ParameterSet parameters) Set this package's metadata with the given parameter set.

Methods inherited from class java.lang.Object

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

Method Detail

close

public final void close()

Description copied from interface: IAutoCloseable

Deletes native counterpart of this auto closable object

Specified by:

close in interface IAutoCloseable

isClosed

public final boolean isClosed()

Tells whether the close() method has been called. Once an object is closed any method will throw IllegalStateException.

Returns:

true if this object is closed.

save

public final void save()
                throws java.io.IOException

Saves all ongoing modifications made to this package.

Throws:

java.io.IOException - when an I/O operation fails.

saveToTemp

public final void saveToTemp()
                      throws java.io.IOException

Saves all ongoing modifications made to this package to a temporary folder. This operation is faster than save().

Note: by default temporary folder is located in the same directory as this package, and named by appending -files to this package's name.

Note: temporary folder location can be set via the content-package.temp-folder configuration property.

Throws:

java.io.IOException - when an I/O operation fails.

saveAs

public final void saveAs(java.io.File file)
                  throws java.io.IOException

Saves all ongoing modifications made to this package, to a new file.

Parameters:

file - the new file name.

Throws:

java.io.IOException - when an I/O operation fails.

getPartCount

public final int getPartCount()

Returns the number of parts in this package.

Returns:

the part count.

getPart

public final ContentPart getPart(int index)
                          throws java.lang.IndexOutOfBoundsException

Returns the part at the specified index.

Parameters:

index - the index of the requested part.

Returns:

the requested part.

Throws:

java.lang.IndexOutOfBoundsException - when index is out of range.

getPart

public final ContentPart getPart(java.lang.String id)
                          throws java.lang.IllegalArgumentException

Returns the specified part.

Parameters:

id - the identifier of the requested part.

Returns:

the part.

Throws:

java.lang.IllegalArgumentException - when no part is associated with identifier id.

indexOfPart

public final int indexOfPart(ContentPart part)

Returns the index of a given part.

Parameters:

part - the part.

Returns:

the index of the part, or -1 if the part does not belong to this package.

createPart

public final ContentPart createPart(java.lang.String type)
                             throws java.lang.IllegalArgumentException

Appends a new part to this package.

Parameters:

type - the type of part.

Returns:

the newly created part.

Throws:

java.lang.IllegalArgumentException - when type is not a valid ContentPart type.

removePart

public final void removePart(ContentPart part)
                      throws java.lang.IllegalArgumentException

Removes the specified part.

Parameters:

part - the part to remove.

Throws:

java.lang.IllegalArgumentException - when part does not belong to this package.

Since:

1.2

clonePart

public final ContentPart clonePart(ContentPart part)

Adds an existing part to this package.

Note: Part modifications that have not been saved (to temporary directory or to an actual package file) will not be imported.

Note: The part can be an existing part from this package or from another open package.

Parameters:

part - the part to clone into this package.

Returns:

the newly created part.

Throws:

java.lang.IllegalArgumentException - when part is not valid.

Since:

1.2

extractObject

public final void extractObject(java.lang.String url,
                                java.io.File file)
                         throws java.io.IOException,
                                java.lang.IllegalArgumentException

Extracts an object from this package to a given file.

Parameters:

url - URL of the object.

file - destination file.

Throws:

java.lang.IllegalArgumentException - when no object named url exists.

java.io.IOException - when an I/O operation fails.

getMetadata

public final ParameterSet getMetadata()

Returns this package's metadata as a parameter set.

Returns:

the metadata.

setMetadata

public final void setMetadata(ParameterSet parameters)

Set this package's metadata with the given parameter set.

Parameters:

parameters - the metadata.