Index (Project Layout 1.1.0 API)

C D E F G I J K M O P R S T W
All Classes and Interfaces|All Packages|Constant Field Values

C

Class diagram - Search tag in Overview: Section

D

DefaultProjectLayout - Class in org.machanism.machai.project.layout: Minimal fallback ProjectLayout implementation.
DefaultProjectLayout() - Constructor for class org.machanism.machai.project.layout.DefaultProjectLayout
Detect a layout and resolve conventional folders - Search tag in Overview: Section
detectProjectLayout(File) - Static method in class org.machanism.machai.project.ProjectLayoutManager: Detects the project layout based on the contents of the specified directory.

E

Example - Search tag in class org.machanism.machai.project.layout.ProjectLayout: Section
Example - Search tag in package org.machanism.machai.project: Section
Example - Search tag in package org.machanism.machai.project.layout: Section
Examples - Search tag in Overview: Section

F

findDirectories(File) - Static method in class org.machanism.machai.project.layout.ProjectLayout: Recursively lists all directories, excluding known build/tooling directories.
findFiles(File) - Static method in class org.machanism.machai.project.layout.ProjectLayout: Recursively lists all files under a directory, excluding known build/tooling directories.

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.GragleProjectLayout: 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: Gets list of document directories for the Python project.
getExcludeDirs() - Static method in class org.machanism.machai.project.layout.ProjectLayout: Returns a copy of the exclude directories array to prevent external modification.
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.GragleProjectLayout: 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 or null for non-parent project.
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 parsed from pom.xml files.
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.GragleProjectLayout: 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.GragleProjectLayout: 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.GragleProjectLayout: 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: Gets list of source directories for the Python project.
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.GragleProjectLayout: 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: Gets list of test source directories for the Python project.
GragleProjectLayout - Class in org.machanism.machai.project.layout: A Gradle-specific ProjectLayout implementation.
GragleProjectLayout() - Constructor for class org.machanism.machai.project.layout.GragleProjectLayout

I

isGradleProject(File) - Static method in class org.machanism.machai.project.layout.GragleProjectLayout: 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 the provided directory is a Python project.

J

JScriptProjectLayout - Class in org.machanism.machai.project.layout: A project layout utility for JavaScript/TypeScript-based projects.
JScriptProjectLayout() - Constructor for class org.machanism.machai.project.layout.JScriptProjectLayout

K

Key concepts - Search tag in Overview: Section

M

MACHAI_TEMP_DIR - Static variable in class org.machanism.machai.project.ProjectProcessor: Name of the directory holding temporary documentation inputs.
MavenProjectLayout - Class in org.machanism.machai.project.layout: A Maven-specific ProjectLayout implementation.
MavenProjectLayout() - Constructor for class org.machanism.machai.project.layout.MavenProjectLayout
model(Model) - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Sets the Maven model directly.

O

org.machanism.machai.project - Search tag in Overview: Section
org.machanism.machai.project - package org.machanism.machai.project: Facilities for discovering, describing, and processing a source-code project rooted at a filesystem directory.
org.machanism.machai.project.layout - Search tag in Overview: Section
org.machanism.machai.project.layout - package org.machanism.machai.project.layout: APIs for detecting, describing, and working with a repository's on-disk project layout.

P

Packages - Search tag in Overview: Section
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
printModel(Model) - Static method in class org.machanism.machai.project.layout.PomReader: Serializes a Maven Model to its string (XML) representation.
processFolder(ProjectLayout) - Method in class org.machanism.machai.project.ProjectProcessor: Processes a project folder layout.
processModule(File, String) - Method in class org.machanism.machai.project.ProjectProcessor: Processes a given project module by recursively scanning.
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.
projectDir(File) - Method in class org.machanism.machai.project.layout.DefaultProjectLayout
projectDir(File) - Method in class org.machanism.machai.project.layout.GragleProjectLayout: 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: Manages detection and instantiation of specific ProjectLayout implementations based on the structure of a given project directory.
ProjectProcessor - Class in org.machanism.machai.project: Abstract base class for processing project structures and modules.
ProjectProcessor() - Constructor for class org.machanism.machai.project.ProjectProcessor
Provided implementations - Search tag in package org.machanism.machai.project.layout: Section
PythonProjectLayout - Class in org.machanism.machai.project.layout: Project layout implementation for Python-based projects.
PythonProjectLayout() - Constructor for class org.machanism.machai.project.layout.PythonProjectLayout

R

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

Scan a repository tree with a processor - Search tag in Overview: Section
scanFolder(File) - Method in class org.machanism.machai.project.ProjectProcessor: Scans the main project directory, detects modules, and processes them.

T

Terminology - Search tag in package org.machanism.machai.project.layout: Section
Typical workflow - Search tag in Overview: Section
Typical workflow - Search tag in package org.machanism.machai.project: Section

W

What this module provides - Search tag in Overview: Section

C D E F G I J K M O P R S T W
All Classes and Interfaces|All Packages|Constant Field Values