Package org.apache.jackrabbit.vault.fs

Class HintArtifact

java.lang.Object

org.apache.jackrabbit.vault.fs.impl.AbstractArtifact

org.apache.jackrabbit.vault.fs.HintArtifact

All Implemented Interfaces:

Artifact, Dumpable, ExportArtifact, ImportArtifact

public class HintArtifact
extends org.apache.jackrabbit.vault.fs.impl.AbstractArtifact
implements ExportArtifact, ImportArtifact

Implements a generic hint artifact.

Constructor Summary

Constructors

Constructor	Description
HintArtifact(String name)	Constructs a new directory type artifact with the given repository name.
HintArtifact(String name, String extension)	Constructs a new directory type artifact with the given repository name and extension

Method Summary

Modifier and Type	Method	Description
long	getContentLength()	Returns the length of the serialized data if it's known without doing the actual serialization.
VaultInputSource	getInputSource()	Returns an input source to the contents of this artifact.
InputStream	getInputStream()	Returns the input stream to the contents of this artifact.
long	getLastModified()	Returns the last modified date or 0 if not known.
AccessType	getPreferredAccess()	Returns the preferred access value for this artifact.
SerializationType	getSerializationType()	Returns the serialization type of this artifact.
void	spool(OutputStream out)	Writes the content to the given output stream and closes it afterwards.

Methods inherited from class org.apache.jackrabbit.vault.fs.impl.AbstractArtifact

dump, equals, getContentType, getExtension, getPlatformPath, getRelativePath, getType, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.jackrabbit.vault.fs.api.Artifact

getContentType, getExtension, getPlatformPath, getRelativePath, getType

Methods inherited from interface org.apache.jackrabbit.vault.fs.api.Dumpable

dump

Constructor Detail

HintArtifact

public HintArtifact(String name)

Constructs a new directory type artifact with the given repository name.

Parameters:

name - the repository name for this artifact.

HintArtifact

public HintArtifact(String name,
                    String extension)

Constructs a new directory type artifact with the given repository name and extension

Parameters:

name - the repository name for this artifact.

extension - the extension for this artifact

Method Detail

getSerializationType

public SerializationType getSerializationType()

Returns the serialization type of this artifact.

Specified by:

getSerializationType in interface Artifact

Returns:

the serialization type of this artifact.

getPreferredAccess

public AccessType getPreferredAccess()

Returns the preferred access value for this artifact.

Specified by:

getPreferredAccess in interface Artifact

Returns:

always AccessType.NONE

spool

public void spool(OutputStream out)
           throws IOException,
                  RepositoryException

Writes the content to the given output stream and closes it afterwards. This is the preferred method to use for output-artifacts.

The specified stream remains open after this method returns.

Specified by:

spool in interface Artifact

Overrides:

spool in class org.apache.jackrabbit.vault.fs.impl.AbstractArtifact

Parameters:

out - the output stream to spool to

Throws:

IOException - if an I/O error occurs

RepositoryException - if a repository error occurs

getInputStream

public InputStream getInputStream()
                           throws IOException,
                                  RepositoryException

Returns the input stream to the contents of this artifact. This is the preferred method to use for input-artifacts.

Specified by:

getInputStream in interface Artifact

Returns:

a input stream to the contents of this artifact.

Throws:

IOException - if an I/O error occurs

RepositoryException - if a repository error occurs

getInputSource

public VaultInputSource getInputSource()
                                throws IOException,
                                       RepositoryException

Returns an input source to the contents of this artifact. This is also preferred for AccessType.STREAM.

Specified by:

getInputSource in interface Artifact

Returns:

an input source.

Throws:

IOException - if an I/O error occurs.

RepositoryException - of a repository error occurs.

getContentLength

public long getContentLength()

Returns the length of the serialized data if it's known without doing the actual serialization.

Specified by:

getContentLength in interface Artifact

Returns:

the length or -1 if the length cannot be determined.

getLastModified

public long getLastModified()

Returns the last modified date or 0 if not known.

Specified by:

getLastModified in interface Artifact

Returns:

the last modified date or 0