org.opendaylight.yangtools.yang2sources.plugin.YangProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yang-maven-plugin Show documentation

This plugin is a wrapper for "yang to source code" generation. It can be configured by a set of third-party code generators and resource providers. For further info see available goals. Sample usage: TODO: add sample usage when finished

There is a newer version: 14.0.4

Show newest version

/*
 * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang2sources.plugin;

import com.google.common.io.Files;
import java.io.File;
import java.io.IOException;
import java.util.Collection;
import org.apache.maven.model.Resource;
import org.apache.maven.project.MavenProject;
import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

abstract class YangProvider {
    private static final class Default extends YangProvider {
        private static final Logger LOG = LoggerFactory.getLogger(Default.class);

        @Override
        void addYangsToMetaInf(final MavenProject project, final Collection modelsInProject)
                throws IOException {

            final File generatedYangDir = new GeneratedDirectories(project).getYangDir();
            LOG.debug("Generated dir {}", generatedYangDir);

            // copy project's src/main/yang/*.yang to ${project.builddir}/generated-sources/yang/META-INF/yang/
            // This honors setups like a Eclipse-profile derived one
            final File withMetaInf = new File(generatedYangDir, YangToSourcesProcessor.META_INF_YANG_STRING);

            for (YangTextSchemaSource source : modelsInProject) {
                final String fileName = source.getIdentifier().toYangFilename();
                final File file = new File(withMetaInf, fileName);
                Files.createParentDirs(file);

                source.copyTo(Files.asByteSink(file));
                LOG.debug("Created file {} for {}", file, source.getIdentifier());
            }

            setResource(generatedYangDir, project);
            LOG.debug("{} YANG files marked as resources: {}", YangToSourcesProcessor.LOG_PREFIX, generatedYangDir);
        }
    }

    private static final YangProvider DEFAULT = new Default();

    static YangProvider getInstance() {
        return DEFAULT;
    }

    abstract void addYangsToMetaInf(MavenProject project, Collection modelsInProject)
            throws IOException;

    static void setResource(final File targetYangDir, final MavenProject project) {
        Resource res = new Resource();
        res.setDirectory(targetYangDir.getPath());
        project.addResource(res);
    }
}