Index (Project Layout 1.4.2-SNAPSHOT API)

A C D E G I J L M N O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values

A

Architecture and behavior - Search tag in Overview: Section

C

Choosing a layout - Search tag in package org.machanism.machai.project.layout: Section
collectMatchingModules(Set<String>, String) - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Adds workspace directories matching a glob and containing package.json.

D

defaultLicenses - Variable in class org.machanism.machai.project.layout.PomReader: Licenses reused when a subsequently parsed model omits license metadata.
DefaultProjectLayout - Class in org.machanism.machai.project.layout: Minimal fallback ProjectLayout implementation.
DefaultProjectLayout() - Constructor for class org.machanism.machai.project.layout.DefaultProjectLayout: Creates a default project layout instance.
detectProjectLayout(File) - Static method in class org.machanism.machai.project.ProjectLayoutManager: Detects the project layout from descriptors in the specified directory and assigns that directory to the resulting layout.

E

Example - Search tag in class org.machanism.machai.project.layout.ProjectLayout: Section
excludeDirs - Variable in class org.machanism.machai.project.layout.ProjectLayout: Directory names that should be ignored when scanning projects.

G

getDocuments() - Method in class org.machanism.machai.project.layout.DefaultProjectLayout: Returns a list of documentation roots for this layout.
getDocuments() - Method in class org.machanism.machai.project.layout.GradleProjectLayout: Returns conventional documentation roots for Gradle projects.
getDocuments() - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Returns a list of conventional documentation directories for JS/TS projects.
getDocuments() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns documentation source directories for Maven projects.
getDocuments() - Method in class org.machanism.machai.project.layout.ProjectLayout: Returns the root-relative documentation directories.
getDocuments() - Method in class org.machanism.machai.project.layout.PythonProjectLayout: Returns documentation directories discovered for the Python project.
getExcludeDirs() - Method in class org.machanism.machai.project.layout.ProjectLayout: Returns the mutable list of directory exclusion patterns used by this layout's directory-scanning operations.
getModel() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns the parsed Maven model for the configured project directory.
getModules() - Method in class org.machanism.machai.project.layout.DefaultProjectLayout: Returns a list of module directory names present in the configured project directory.
getModules() - Method in class org.machanism.machai.project.layout.GradleProjectLayout: Returns a list of child module names for multi-project Gradle builds.
getModules() - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Returns workspace modules listed in package.json under the workspaces key.
getModules() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns a list of modules for multi-module Maven projects.
getModules() - Method in class org.machanism.machai.project.layout.ProjectLayout: Returns a list of module directories (or names) within this project.
getPackageJson() - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Loads and parses package.json in the current project directory.
getParentId() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns the parent artifactId, if a parent is configured.
getParentId() - Method in class org.machanism.machai.project.layout.ProjectLayout: Returns the parent project identifier, when available.
getPomProperties() - Method in class org.machanism.machai.project.layout.PomReader: Returns properties collected while parsing POM files.
getProject() - Method in class org.machanism.machai.project.layout.GradleProjectLayout: Loads and caches the Gradle model for the configured project root.
getProjectDir() - Method in class org.machanism.machai.project.layout.ProjectLayout: Returns the configured project root directory.
getProjectId() - Method in class org.machanism.machai.project.layout.GradleProjectLayout: Returns the Gradle project name as a stable identifier.
getProjectId() - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Returns the package name from package.json.
getProjectId() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns the Maven artifactId as the project identifier.
getProjectId() - Method in class org.machanism.machai.project.layout.ProjectLayout: Returns a stable project identifier, when available.
getProjectLayout(File) - Method in class org.machanism.machai.project.ProjectProcessor: Returns the detected ProjectLayout for the specified project directory.
getProjectLayoutType() - Method in class org.machanism.machai.project.layout.ProjectLayout: Returns the layout type name (derived from the implementing class name).
getProjectModel(File) - Method in class org.machanism.machai.project.layout.PomReader: Loads and returns the Maven model from a pom.xml file.
getProjectName() - Method in class org.machanism.machai.project.layout.GradleProjectLayout: Returns the Gradle project name.
getProjectName() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns the Maven project name.
getProjectName() - Method in class org.machanism.machai.project.layout.ProjectLayout: Returns a human-friendly project name, when available.
getRelativePath(File, File) - Static method in class org.machanism.machai.project.layout.ProjectLayout: Computes the relative path from the specified project directory to the target file.
getRelativePath(File, File, boolean) - Static method in class org.machanism.machai.project.layout.ProjectLayout: Computes the relative path from the specified project directory to the target file.
getRelativePath(String, File) - Method in class org.machanism.machai.project.layout.ProjectLayout: Computes a root-relative path for a file, based on the provided base path.
getSources() - Method in class org.machanism.machai.project.layout.DefaultProjectLayout: Returns a list of source roots for this layout.
getSources() - Method in class org.machanism.machai.project.layout.GradleProjectLayout: Returns conventional production source roots for Gradle projects.
getSources() - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Returns a list of conventional source directories for JS/TS projects.
getSources() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns a list of source directories for the Maven project.
getSources() - Method in class org.machanism.machai.project.layout.ProjectLayout: Returns the root-relative source directories for production code.
getSources() - Method in class org.machanism.machai.project.layout.PythonProjectLayout: Returns source directories discovered for the Python project.
getTempDir() - Static method in class org.machanism.machai.project.layout.ProjectLayout: Returns the system temporary directory path, initializing it if necessary.
getTests() - Method in class org.machanism.machai.project.layout.DefaultProjectLayout: Returns a list of test source roots for this layout.
getTests() - Method in class org.machanism.machai.project.layout.GradleProjectLayout: Returns conventional test source roots for Gradle projects.
getTests() - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Returns a list of conventional test directories for JS/TS projects.
getTests() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns a list of test directories for the Maven project.
getTests() - Method in class org.machanism.machai.project.layout.ProjectLayout: Returns the root-relative source directories for test code.
getTests() - Method in class org.machanism.machai.project.layout.PythonProjectLayout: Returns test source directories discovered for the Python project.
GradleProjectLayout - Class in org.machanism.machai.project.layout: A Gradle-specific ProjectLayout implementation.
GradleProjectLayout() - Constructor for class org.machanism.machai.project.layout.GradleProjectLayout: Creates a Gradle project layout instance.

I

isExcludedPath(File) - Method in class org.machanism.machai.project.layout.ProjectLayout: Checks whether the specified file or directory path matches any of the configured exclusion patterns (glob templates or exact string matches).
isGradleProject(File) - Static method in class org.machanism.machai.project.layout.GradleProjectLayout: Checks whether the given directory appears to be a Gradle project.
isMavenProject(File) - Static method in class org.machanism.machai.project.layout.MavenProjectLayout: Checks whether the given directory appears to be a Maven project.
isPackageJsonPresent(File) - Static method in class org.machanism.machai.project.layout.JScriptProjectLayout: Checks if the specified directory contains a package.json file, indicating a JS/TS project.
isPythonProject(File) - Static method in class org.machanism.machai.project.layout.PythonProjectLayout: Checks whether a directory contains a public Python project described by pyproject.toml.

J

JScriptProjectLayout - Class in org.machanism.machai.project.layout: Describes a JavaScript or TypeScript project that uses package.json.
JScriptProjectLayout() - Constructor for class org.machanism.machai.project.layout.JScriptProjectLayout: Creates a JavaScript/TypeScript project layout instance.

L

listDirectories(File) - Method in class org.machanism.machai.project.layout.ProjectLayout: Recursively lists all directories, excluding known build/tooling directories.
listFiles(File) - Method in class org.machanism.machai.project.layout.ProjectLayout: Recursively lists all files under a directory, excluding known build/tooling directories.
logger - Static variable in class org.machanism.machai.project.layout.GradleProjectLayout: Logger used when the Gradle model cannot be loaded.
logger - Static variable in class org.machanism.machai.project.layout.ProjectLayout: Logger used for layout-wide diagnostic messages.
LOGGER - Static variable in class org.machanism.machai.project.ProjectProcessor: Logger used to record module traversal.

M

MavenProjectLayout - Class in org.machanism.machai.project.layout: A Maven-specific ProjectLayout implementation.
MavenProjectLayout() - Constructor for class org.machanism.machai.project.layout.MavenProjectLayout: Creates a Maven project layout instance.
model - Variable in class org.machanism.machai.project.layout.MavenProjectLayout: Cached Maven model for the configured project root.
model(Model) - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Sets the Maven model directly.
modules - Variable in class org.machanism.machai.project.layout.DefaultProjectLayout: Cached module directory names discovered beneath the project root.

N

NO_MODULES - Static variable in class org.machanism.machai.project.layout.ProjectLayout: Sentinel value indicating that the layout does not declare any modules.
normalizeWorkspaceGlob(String) - Static method in class org.machanism.machai.project.layout.JScriptProjectLayout: Removes the optional leading ./ from a workspace glob.

O

org.machanism.machai.project - package org.machanism.machai.project: Detects project layouts and traverses their module trees.
org.machanism.machai.project.layout - package org.machanism.machai.project.layout: APIs for detecting and describing a repository's on-disk project layout.

P

Packages - Search tag in Overview: Section
parseWorkspaceModules(JsonNode) - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Expands array-form workspace patterns into unique module paths.
pomProperties - Variable in class org.machanism.machai.project.layout.PomReader: Properties collected from the most recently parsed POM files.
PomReader - Class in org.machanism.machai.project.layout: Utility for reading and processing Maven pom.xml files into Maven models.
PomReader() - Constructor for class org.machanism.machai.project.layout.PomReader: Creates a POM reader instance.
Principal types - Search tag in Overview: Section
printModel(Model) - Static method in class org.machanism.machai.project.layout.PomReader: Serializes a Maven model to its XML representation.
processFolder(ProjectLayout) - Method in class org.machanism.machai.project.ProjectProcessor: Processes one detected leaf project layout.
processModule(File, String) - Method in class org.machanism.machai.project.ProjectProcessor: Processes a reported project module by recursively scanning its directory.
project - Variable in class org.machanism.machai.project.layout.GradleProjectLayout: Cached Gradle model for the configured project root.
PROJECT_MODEL_FILE_NAME - Static variable in class org.machanism.machai.project.layout.GradleProjectLayout: Conventional Gradle build descriptor used for project detection.
PROJECT_MODEL_FILE_NAME - Static variable in class org.machanism.machai.project.layout.JScriptProjectLayout: Name of the JS/TS project model file used to detect this layout.
PROJECT_MODEL_FILE_NAME - Static variable in class org.machanism.machai.project.layout.MavenProjectLayout: Conventional Maven project descriptor used for project detection.
PROJECT_MODEL_FILE_NAME - Static variable in class org.machanism.machai.project.layout.PythonProjectLayout: Conventional Python project descriptor used for project detection.
projectDir - Variable in class org.machanism.machai.project.layout.ProjectLayout: Root directory configured for this layout.
projectDir(File) - Method in class org.machanism.machai.project.layout.DefaultProjectLayout: Sets the project root and returns this layout for fluent configuration.
projectDir(File) - Method in class org.machanism.machai.project.layout.GradleProjectLayout: Sets the project directory and narrows the return type for fluent usage.
projectDir(File) - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Sets the project directory and narrows the return type for fluent usage.
projectDir(File) - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Sets the project directory and narrows the return type for fluent usage.
projectDir(File) - Method in class org.machanism.machai.project.layout.ProjectLayout: Sets the project root directory used by this layout.
ProjectLayout - Class in org.machanism.machai.project.layout: Base abstraction for describing a project's conventional on-disk layout.
ProjectLayout() - Constructor for class org.machanism.machai.project.layout.ProjectLayout
Project Layout - Search tag in Overview: Section
ProjectLayoutManager - Class in org.machanism.machai.project: Detects and configures the ProjectLayout appropriate for a project directory.
ProjectLayoutManager() - Constructor for class org.machanism.machai.project.ProjectLayoutManager: Prevents instantiation of this utility class.
ProjectProcessor - Class in org.machanism.machai.project: Traverses a detected project structure and delegates leaf-folder processing to subclasses.
ProjectProcessor() - Constructor for class org.machanism.machai.project.ProjectProcessor: Creates a project processor instance.
PythonProjectLayout - Class in org.machanism.machai.project.layout: Detects public Python projects described by pyproject.toml.
PythonProjectLayout() - Constructor for class org.machanism.machai.project.layout.PythonProjectLayout: Creates a Python project layout instance.

R

replaceProperty(String) - Method in class org.machanism.machai.project.layout.PomReader: Replaces known property placeholders in raw POM content.
Responsibilities - Search tag in package org.machanism.machai.project.layout: Section
Root-relative paths - Search tag in class org.machanism.machai.project.layout.ProjectLayout: Section

S

scanFolder(File) - Method in class org.machanism.machai.project.ProjectProcessor: Detects the layout of the specified directory and processes its leaf projects.
setExcludeDirs(List<String>) - Method in class org.machanism.machai.project.layout.ProjectLayout: Replaces the directory exclusion patterns used by this layout.
Supported layouts - Search tag in package org.machanism.machai.project.layout: Section

T

tempDir - Static variable in class org.machanism.machai.project.layout.ProjectLayout: Cached path to Machai's temporary working directory.
Typical usage - Search tag in package org.machanism.machai.project: Section
Typical usage - Search tag in package org.machanism.machai.project.layout: Section

U

Usage - Search tag in class org.machanism.machai.project.ProjectLayoutManager: Section
Usage - Search tag in class org.machanism.machai.project.ProjectProcessor: Section

W

workspaceModules - Variable in class org.machanism.machai.project.layout.JScriptProjectLayout

A C D E G I J L M N O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values