Add generalized FileGenerator interface
[yangtools.git] / plugin / plugin-generator-api / src / main / java / org / opendaylight / yangtools / plugin / generator / api / package-info.java
1 /*
2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 /**
9  * API exposed by generator plugins, i.e. pluggable pieces of code which want to create code (and other) files from an
10  * {@link org.opendaylight.yangtools.yang.model.api.EffectiveModelContext}.
11  *
12  * <p>
13  * The primary entry point is {@link org.opendaylight.yangtools.plugin.generator.api.FileGeneratorFactory}, which needs
14  * to be implemented for bootstrapping a particular generator. Such implementations are discovered using normal
15  * discovery methods, for example they <b>should</b> always be published as {@link java.util.ServiceLoader} services.
16  */
17 package org.opendaylight.yangtools.plugin.generator.api;