Package org.apache.jackrabbit.vault.fs.io

Class PlatformExporter

java.lang.Object

org.apache.jackrabbit.vault.fs.io.AbstractExporter

org.apache.jackrabbit.vault.fs.io.PlatformExporter

All Implemented Interfaces:

AutoCloseable

public class PlatformExporter
extends AbstractExporter

Implements a Vault filesystem exporter that exports Vault files to a platform file system. It uses the PlatformNameFormat for formatting the jcr file names to local ones.

Field Summary

Fields inherited from class org.apache.jackrabbit.vault.fs.io.AbstractExporter

exportInfo

Constructor Summary

Constructors

Constructor	Description
PlatformExporter(File localFile)	Constructs a new jar exporter that writes to the given file.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the exporter and releases the undelying structures.
void	createDirectory(String relPath)
void	createDirectory(VaultFile file, String relPath)
void	open()	Opens the exporter and initializes the undelying structures.
boolean	pruneMissing()	Checks if 'prune-missing' is enabled.
void	setPruneMissing(boolean pruneMissing)	Sets the 'prune-missing' flag.
void	writeFile(InputStream in, String relPath)	The specified stream is automatically closed after this method returns or throws an exception.
void	writeFile(VaultFile file, String relPath)

Methods inherited from class org.apache.jackrabbit.vault.fs.io.AbstractExporter

export, export, export, getExportInfo, getGenerator, getPlatformFilePath, getRootPath, isNoMetaInf, isRelativePaths, isVerbose, setGenerator, setNoMetaInf, setProperties, setProperty, setProperty, setRelativePaths, setRootPath, setVerbose, track, track

Methods inherited from class java.lang.Object

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

Constructor Detail

PlatformExporter

public PlatformExporter(File localFile)

Constructs a new jar exporter that writes to the given file.

Parameters:

localFile - the local parent directory

Method Detail

pruneMissing

public boolean pruneMissing()

Checks if 'prune-missing' is enabled.

Returns:

true if prune-missing is enabled

setPruneMissing

public void setPruneMissing(boolean pruneMissing)

Sets the 'prune-missing' flag.

Parameters:

pruneMissing - the flag

open

public void open()
          throws IOException,
                 RepositoryException

Opens the exporter and initializes the undelying structures.

Specified by:

open in class AbstractExporter

Throws:

IOException - if an I/O error occurs

RepositoryException - if a repository error occurs

close

public void close()
           throws IOException

Closes the exporter and releases the undelying structures.

Specified by:

close in interface AutoCloseable

Specified by:

close in class AbstractExporter

Throws:

IOException - if an I/O error occurs

createDirectory

public void createDirectory(VaultFile file,
                            String relPath)
                     throws RepositoryException,
                            IOException

Specified by:

createDirectory in class AbstractExporter

Throws:

RepositoryException

IOException

createDirectory

public void createDirectory(String relPath)
                     throws IOException

Specified by:

createDirectory in class AbstractExporter

Throws:

IOException

writeFile

public void writeFile(VaultFile file,
                      String relPath)
               throws RepositoryException,
                      IOException

Specified by:

writeFile in class AbstractExporter

Throws:

RepositoryException

IOException

writeFile

public void writeFile(InputStream in,
                      String relPath)
               throws IOException

Description copied from class: AbstractExporter

The specified stream is automatically closed after this method returns or throws an exception.

Specified by:

writeFile in class AbstractExporter

Throws:

IOException