Package io.fluxzero.tools.jsondoclet.model

Class DirectoryIndex

java.lang.Object

io.fluxzero.tools.jsondoclet.model.DirectoryIndex

public final class DirectoryIndex
extends Object

Index metadata generated per output directory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DirectoryIndex.IndexFileEntry	Simple file entry describing nearby JSON output.
static final record	DirectoryIndex.SubdirectoryEntry	Subdirectory pointer for discovery.

Constructor Summary

Constructors

Constructor	Description
DirectoryIndex()

Method Summary

Modifier and Type	Method	Description
void	addFile(DirectoryIndex.IndexFileEntry entry)	Adds a file entry to the index.
void	addSubdirectory(DirectoryIndex.SubdirectoryEntry entry)	Adds a subdirectory reference to the index.
List<DirectoryIndex.IndexFileEntry>	getFiles()	Files in the current directory that point to generated JSON artifacts.
PackageDocumentation	getPackage()	Returns documentation metadata for the package corresponding to this directory, if any.
List<DirectoryIndex.SubdirectoryEntry>	getSubdirectories()	Subdirectories that contain further index files.
void	setPackage(PackageDocumentation documentation)	Assigns package-level documentation metadata to this directory.

Methods inherited from class java.lang.Object

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

Constructor Details

DirectoryIndex

public DirectoryIndex()

Method Details

getFiles

public List<DirectoryIndex.IndexFileEntry> getFiles()

Files in the current directory that point to generated JSON artifacts.

getSubdirectories

public List<DirectoryIndex.SubdirectoryEntry> getSubdirectories()

Subdirectories that contain further index files.

addFile

public void addFile(DirectoryIndex.IndexFileEntry entry)

Adds a file entry to the index.

addSubdirectory

public void addSubdirectory(DirectoryIndex.SubdirectoryEntry entry)

Adds a subdirectory reference to the index.

setPackage

public void setPackage(PackageDocumentation documentation)

Assigns package-level documentation metadata to this directory.

getPackage

public PackageDocumentation getPackage()

Returns documentation metadata for the package corresponding to this directory, if any.