org.eclipse.edc.plugins.autodoc.spi.ManifestWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of autodoc-converters Show documentation
edc :: autodoc-converters
The newest version!
/*
 *  Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
 *
 *  This program and the accompanying materials are made available under the
 *  terms of the Apache License, Version 2.0 which is available at
 *  https://www.apache.org/licenses/LICENSE-2.0
 *
 *  SPDX-License-Identifier: Apache-2.0
 *
 *  Contributors:
 *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - initial API and implementation
 *
 */

package org.eclipse.edc.plugins.autodoc.spi;

import org.eclipse.edc.runtime.metamodel.domain.EdcModule;
import org.eclipse.edc.runtime.metamodel.domain.EdcServiceExtension;

import java.io.OutputStream;
import java.util.List;
import java.util.Set;

import static java.util.Comparator.comparing;

/**
 * Reads any input to a manifest, which is represented as {@link List} of {@link EdcModule}.
 * All model objects are delegated down to implementors using callbacks.
 */
public class ManifestWriter {

    private final ManifestRenderer renderer;

    public ManifestWriter(ManifestRenderer renderer) {
        this.renderer = renderer;
    }

    public OutputStream convert(List input) {
        beginConversion(input);
        return renderer.finalizeRendering();
    }

    protected void beginConversion(List input) {
        renderer.renderDocumentHeader();
        input.stream().sorted(comparing(EdcModule::getModulePath)).forEach(this::handleModule);
    }

    /**
     * Delegates one top-level element, which are {@link EdcModule} objects.
     * Do not override unless absolutely necessary!
     *
     * @param edcModule The module to render
     */
    protected void handleModule(EdcModule edcModule) {
        renderer.renderModuleHeading(edcModule.getName(), edcModule.getModulePath(), edcModule.getVersion());

        renderer.renderCategories(edcModule.getCategories());

        renderer.renderExtensionPoints(edcModule.getExtensionPoints());

        handleExtensions(edcModule.getExtensions());
    }

    protected void handleExtensions(Set extensions) {
        renderer.renderExtensionHeading();
        extensions.forEach(this::handleServiceExtension);
    }

    protected void handleServiceExtension(EdcServiceExtension serviceExtension) {
        renderer.renderExtensionHeader(serviceExtension.getClassName(), serviceExtension.getName(), serviceExtension.getOverview(), serviceExtension.getType());

        renderer.renderConfigurations(serviceExtension.getConfiguration());

        renderer.renderProvidedServices(serviceExtension.getProvides());

        renderer.renderReferencedServices(serviceExtension.getReferences());
    }

}