Add generalized FileGenerator interface
[yangtools.git] / plugin / plugin-generator-api / src / main / java / org / opendaylight / yangtools / plugin / generator / api / GeneratedFileLifecycle.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 package org.opendaylight.yangtools.plugin.generator.api;
9
10 import com.google.common.annotations.Beta;
11 import org.eclipse.jdt.annotation.NonNullByDefault;
12
13 /**
14  * Lifecycle policy of a generated file. This governs how existing files interact with newly-generated bodies.
15  *
16  * @author Robert Varga
17  */
18 @Beta
19 @NonNullByDefault
20 public enum GeneratedFileLifecycle {
21     /**
22      * Generated file should be transient and is not expected to be further modified.
23      */
24     TRANSIENT,
25     /**
26      * Generated file should be persistent and potentially customized. It should not be overwritten if it already
27      * exists.
28      */
29     PERSISTENT,
30 }