Package lib.aide.resource.collection

Class VfsResources

java.lang.Object

lib.aide.resource.collection.VfsResources

All Implemented Interfaces:

ResourcesSupplier<VfsResources.VfsFileObjectProvenance,String,Resource<? extends Nature,?>>

public class VfsResources
extends Object
implements ResourcesSupplier<VfsResources.VfsFileObjectProvenance,String,Resource<? extends Nature,?>>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VfsResources.VfsFileObjectProvenance
class	VfsResources.VfsForwardableNature
class	VfsResources.VfsForwardableResource

Constructor Summary

Constructors

Constructor	Description
VfsResources(ResourceFactory rf, URI identity, org.apache.commons.vfs2.FileObject rootVfsFO)

Method Summary

Modifier and Type	Method	Description
VfsResources	clearCache()	Call clearCache().resources() or clearCache().paths() to re-read from sources.
static Optional<Path>	findRelativeDirectory(String relativePath, Optional<Path> startFrom)	Searches for a specific relative directory path by traversing up the parent directories from the given start directory or the current directory if no start directory is provided.
URI	identity()
Paths<String,ResourceProvenance<VfsResources.VfsFileObjectProvenance,Resource<? extends Nature,?>>>	paths()
VfsResources	populateAbsolutePaths(boolean value)
List<ResourceProvenance<VfsResources.VfsFileObjectProvenance,Resource<? extends Nature,?>>>	resources()

Methods inherited from class java.lang.Object

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

Constructor Details

VfsResources

public VfsResources(ResourceFactory rf,
 URI identity,
 org.apache.commons.vfs2.FileObject rootVfsFO)
             throws Exception

Throws:

Exception

Method Details

populateAbsolutePaths

public VfsResources populateAbsolutePaths(boolean value)

identity

public URI identity()

Specified by:

identity in interface ResourcesSupplier<VfsResources.VfsFileObjectProvenance,String,Resource<? extends Nature,?>>

paths

public Paths<String,ResourceProvenance<VfsResources.VfsFileObjectProvenance,Resource<? extends Nature,?>>> paths()

Specified by:

paths in interface ResourcesSupplier<VfsResources.VfsFileObjectProvenance,String,Resource<? extends Nature,?>>

resources

public List<ResourceProvenance<VfsResources.VfsFileObjectProvenance,Resource<? extends Nature,?>>> resources()

Specified by:

resources in interface ResourcesSupplier<VfsResources.VfsFileObjectProvenance,String,Resource<? extends Nature,?>>

clearCache

public VfsResources clearCache()

Call clearCache().resources() or clearCache().paths() to re-read from sources.

Returns:

this resources supplier instance to allow fluent chaining

findRelativeDirectory

public static Optional<Path> findRelativeDirectory(String relativePath,
 Optional<Path> startFrom)

Searches for a specific relative directory path by traversing up the parent directories from the given start directory or the current directory if no start directory is provided.

Parameters:

relativePath - the relative directory path to search for.

startFrom - an optional starting directory. If not provided, the search starts from the current directory.

Returns:

an Optional containing the found directory path if it exists, otherwise Optional.empty().