Package io.github.sandydunlop.markista.spi
Interface DocService
java.lang.Object
io.github.sandydunlop.markista.spi.DocService
public interface DocService
This interface defines a service for processing a project's structure and documentation with the Markista markdown doclet. The DocService interface is part of the Service Provider Interface (SPI) design pattern, which allows for the dynamic discovery and loading of service implementations at runtime.
Implementations of this interface can be created to provide various algorithms or strategies for processing project structures and documentation. By adhering to this SPI, developers can extend the functionality of Markista without modifying its core codebase, promoting a modular and flexible architecture.
Additionally, this interface is designed to work seamlessly with the Java Platform Module System (JPMS), which enhances the modularity of Java applications. JPMS allows for better encapsulation and management of dependencies, enabling developers to create well-defined modules that can interact with the Markista framework. This modular approach facilitates the integration of third-party services and custom implementations, ensuring that they can be easily added or replaced as needed.
When the structure (including documentation) is processed by Markista,
it is subsequently passed into the DocService's run method, where
custom processing logic can be executed. This design makes it easier to
maintain and extend the documentation processing capabilities of Markista.
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
| public abstract boolean | replacesDefault() | Returns true if this Docservice replaces the default DocService. |
| public abstract boolean | start(Api api, Context ctx) | Runs before the main Markdown DocService. |
| public abstract boolean | finish() | Runs after the main Markdown DocService. |
Method Details
replacesDefault
public abstract boolean replacesDefault
Returns true if this Docservice replaces the default DocService.
Returns:
true if this DocService replaces the default Markdown one, false otherwise.
start
public abstract boolean start
Runs before the main Markdown DocService. Initializes a DocService with the API model and a Context for file creation and reporting.
Returns:
true on success, otheriwse false
finish
public abstract boolean finish
Runs after the main Markdown DocService.
Returns:
true on success, otheriwse false