Package org.gcube.informationsystem.documentation

Class IsolatedClassLoaderExecutor

java.lang.Object

org.gcube.informationsystem.documentation.IsolatedClassLoaderExecutor

public class IsolatedClassLoaderExecutor
extends Object

Executes model documentation generation inside an isolated classloader built from the compile classpath of the target Maven project.

Author:

Luca Frosini (ISTI - CNR)

Constructor Summary

Constructors

Constructor	Description
IsolatedClassLoaderExecutor()

Method Summary

Modifier and Type	Method	Description
void	execute(List<String> classpathElements, String registrationProviderClassName, File outputDirectory, String format, boolean failOnDanglingTypeReference)	Runs documentation generation using the provided classpath elements.

Methods inherited from class java.lang.Object

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

Constructor Details

IsolatedClassLoaderExecutor

public IsolatedClassLoaderExecutor()

Method Details

execute

public void execute(List<String> classpathElements,
 String registrationProviderClassName,
 File outputDirectory,
 String format,
 boolean failOnDanglingTypeReference)
             throws Exception

Runs documentation generation using the provided classpath elements.

Parameters:

classpathElements - list of file paths (JARs and directories) constituting the project's compile classpath

registrationProviderClassName - fully-qualified class name of the RegistrationProvider to use, or null to discover all available providers via ServiceLoader

outputDirectory - the directory where documentation files should be generated

format - the documentation format to generate (e.g. "md" or "html")

failOnDanglingTypeReference - whether a description linking a name that is not a known type fails the generation

Throws:

Exception - if classloading or documentation generation fails