com.day.jcr.vault.fs.io

Class JrVltArchiveAdapter

java.lang.Object

com.day.jcr.vault.fs.io.JrVltArchiveAdapter

All Implemented Interfaces:

Archive

Direct Known Subclasses:

FileArchive, JcrArchive, ZipArchive

public class JrVltArchiveAdapter
extends java.lang.Object
implements Archive

JrVltArchive...

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JrVltArchiveAdapter.EntryAdapter

Nested classes/interfaces inherited from interface com.day.jcr.vault.fs.io.Archive

Archive.Entry

Method Summary

Modifier and Type	Method and Description
void	close() closes the archive
static Archive	create(Archive archive)
Archive.Entry	getEntry(java.lang.String path) Returns the entry specified by path.
VaultInputSource	getInputSource(Archive.Entry entry) Returns an input source for the given entry
Archive.Entry	getJcrRoot() Returns the entry that specifies the "jcr_root".
MetaInf	getMetaInf() Returns the meta inf.
Archive.Entry	getRoot() Returns the root entry.
Archive	getSubArchive(java.lang.String root, boolean asJcrRoot) Returns a sub archive that is rooted at the given path.
void	open(boolean strict) Opens the archive.
java.io.InputStream	openInputStream(Archive.Entry entry) Opens an input stream for the given entry
Archive	unwrap()

Methods inherited from class java.lang.Object

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

Method Detail

unwrap

public Archive unwrap()

create

public static Archive create(Archive archive)

open

public void open(boolean strict)
          throws java.io.IOException

Description copied from interface: Archive

Opens the archive.

Specified by:

open in interface Archive

Parameters:

strict - if true open will fail if there was an internal error while parsing meta data.

Throws:

java.io.IOException - if an error occurs

openInputStream

public java.io.InputStream openInputStream(Archive.Entry entry)
                                    throws java.io.IOException

Description copied from interface: Archive

Opens an input stream for the given entry

Specified by:

openInputStream in interface Archive

Parameters:

entry - the entry

Returns:

the input stream

Throws:

java.io.IOException - if an error occurs

getInputSource

public VaultInputSource getInputSource(Archive.Entry entry)
                                throws java.io.IOException

Description copied from interface: Archive

Returns an input source for the given entry

Specified by:

getInputSource in interface Archive

Parameters:

entry - the entry

Returns:

the input source

Throws:

java.io.IOException - if an error occurs

getJcrRoot

public Archive.Entry getJcrRoot()
                         throws java.io.IOException

Description copied from interface: Archive

Returns the entry that specifies the "jcr_root". if no such entry exists, null is returned.

Specified by:

getJcrRoot in interface Archive

Returns:

the jcr_root entry or null

Throws:

java.io.IOException - if an error occurs

getRoot

public Archive.Entry getRoot()
                      throws java.io.IOException

Description copied from interface: Archive

Returns the root entry.

Specified by:

getRoot in interface Archive

Returns:

the root entry.

Throws:

java.io.IOException - if an error occurs

getMetaInf

public MetaInf getMetaInf()

Description copied from interface: Archive

Returns the meta inf. If the archive provides no specific meta data, a default, empty meta inf is returned.

Specified by:

getMetaInf in interface Archive

Returns:

the meta inf.

getEntry

public Archive.Entry getEntry(java.lang.String path)
                       throws java.io.IOException

Description copied from interface: Archive

Returns the entry specified by path.

Specified by:

getEntry in interface Archive

Parameters:

path - the path

Returns:

the entry or null if not found.

Throws:

java.io.IOException - if an error occurs

getSubArchive

public Archive getSubArchive(java.lang.String root,
                             boolean asJcrRoot)
                      throws java.io.IOException

Description copied from interface: Archive

Returns a sub archive that is rooted at the given path. Note that sub archives currently can't have they own meta inf and are closed automatically if they base is closed.

Specified by:

getSubArchive in interface Archive

Parameters:

root - root path

asJcrRoot - if true the given root is the jcr_root

Returns:

the archive or null if entry specified by root does not exist.

Throws:

java.io.IOException - if an error occurs

close

public void close()

Description copied from interface: Archive

closes the archive

Specified by:

close in interface Archive