1 package org.codehaus.mojo.jaxb2.shared.environment;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * <p>Specification for an Environment controller, which can infer a temporary and reversible change
24 * to the environment of an executing task. Any changes performed by this Environment
25 * must be reversible, and should be restored to their original values in the {@code restore()} method.</p>
26 * <p>EnvironmentFacets are required since the JDK tools (XJC, SchemaGen, JXC) expect certain configuration
27 * or setup to be present during their execution. For improved usability within the JAXB2-Maven-Plugin, we
28 * would like to supply all configuration to the plugin, and delegate the setting of various system-, thread-,
29 * logging- or environment properties to explicit EnvironmentFacet implementations.</p>
30 *
31 * @author <a href="mailto:lj@jguru.se">Lennart Jörelid</a>, jGuru Europe AB
32 * @since 2.1
33 */
34 public interface EnvironmentFacet {
35
36 /**
37 * Sets up this Environment, inferring temporary changes to environment variables or conditions.
38 * The changes must be reversible, and should be restored to their original values in the {@code restore()} method.
39 */
40 void setup();
41
42 /**
43 * Restores the original Environment, implying that the change performed in {@code setup()}
44 * method are restored to the state before the setup method was called.
45 */
46 void restore();
47 }