Package org.apache.jackrabbit.vault.packaging.registry.impl

Class FSInstallState

java.lang.Object

org.apache.jackrabbit.vault.packaging.registry.impl.FSInstallState

public class FSInstallState
extends Object

Internal (immutable) state object for a package to cache and pass the relevant metadata around.

Constructor Summary

Constructors

Constructor	Description
FSInstallState(@NotNull PackageId pid, @NotNull FSPackageStatus status, @NotNull Path filePath)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static @Nullable FSInstallState	fromFile(Path metaFile)	Parses InstallState from metafile.
static @Nullable FSInstallState	fromStream(InputStream in, String systemId)	Parses InstallState from metafile.
Set<Dependency>	getDependencies()
Path	getFilePath()
WorkspaceFilter	getFilter()
Long	getInstallationTime()
PackageId	getPackageId()
Properties	getProperties()
long	getSize()
FSPackageStatus	getStatus()
Map<PackageId,SubPackageHandling.Option>	getSubPackages()
int	hashCode()
boolean	isExternal()
void	save(OutputStream out)	Persists the installState to a metadatafile
void	save(Path file)	Persists the installState to a metadatafile
String	toString()
FSInstallState	withDependencies(Set<Dependency> dependencies)
FSInstallState	withExternal(boolean external)
FSInstallState	withFilter(WorkspaceFilter filter)
FSInstallState	withInstallTime(Long installTime)
FSInstallState	withProperties(Properties properties)
FSInstallState	withSize(long size)
FSInstallState	withSubPackages(Map<PackageId,SubPackageHandling.Option> subPackages)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FSInstallState

public FSInstallState(@NotNull
                      @NotNull PackageId pid,
                      @NotNull
                      @NotNull FSPackageStatus status,
                      @NotNull
                      @NotNull Path filePath)

Method Detail

withExternal

public FSInstallState withExternal(boolean external)

withDependencies

public FSInstallState withDependencies(Set<Dependency> dependencies)

withSubPackages

public FSInstallState withSubPackages(Map<PackageId,SubPackageHandling.Option> subPackages)

withInstallTime

public FSInstallState withInstallTime(Long installTime)

withSize

public FSInstallState withSize(long size)

withFilter

public FSInstallState withFilter(WorkspaceFilter filter)

withProperties

public FSInstallState withProperties(Properties properties)

fromFile

@Nullable
public static @Nullable FSInstallState fromFile(Path metaFile)
                                         throws IOException

Parses InstallState from metafile.

Parameters:

metaFile - The meta file.

Returns:

Install state or null if file is not metafile format

Throws:

IOException - in case root tag is correct but structure not parsable as expected

fromStream

@Nullable
public static @Nullable FSInstallState fromStream(InputStream in,
                                                  String systemId)
                                           throws IOException

Parses InstallState from metafile.

Parameters:

in - The input stream

systemId - the id of the stream

Returns:

Install state or null if file is not metafile format

Throws:

IOException - in case root tag is correct but structure not parsable as expected

save

public void save(Path file)
          throws IOException

Persists the installState to a metadatafile

Parameters:

file - The files to save the state to

Throws:

IOException - if an error occurs.

save

public void save(OutputStream out)
          throws IOException

Persists the installState to a metadatafile

Parameters:

out - Outputsteam to write to.

Throws:

IOException - if an error occurs.

getInstallationTime

public Long getInstallationTime()

getSubPackages

public Map<PackageId,SubPackageHandling.Option> getSubPackages()

getPackageId

public PackageId getPackageId()

getFilePath

public Path getFilePath()

isExternal

public boolean isExternal()

getStatus

public FSPackageStatus getStatus()

getDependencies

public Set<Dependency> getDependencies()

getSize

public long getSize()

getFilter

public WorkspaceFilter getFilter()

getProperties

public Properties getProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object