SystemPropertyChangeEnvironmentFacet (JAXB-2 Maven Plugin 3.1.0 API)

java.lang.Object
- org.codehaus.mojo.jaxb2.shared.environment.AbstractLogAwareFacet
- - org.codehaus.mojo.jaxb2.shared.environment.sysprops.SystemPropertyChangeEnvironmentFacet

All Implemented Interfaces:

EnvironmentFacet
```
public final class SystemPropertyChangeEnvironmentFacet
extends AbstractLogAwareFacet
```
EnvironmentFacet which changes the value of a system property for the duration of executing a tool. This is required for tools (such as the JDK SchemaGen) which relies on environment or system properties being set for their execution. This faced accepts one key and two values (original/new values).

Since:

2.1

Author:

Lennart Jörelid, jGuru Europe AB

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SystemPropertyChangeEnvironmentFacet.ChangeType`	Operation definitions indicating how a System property should be changed by this EnvironmentFacet.
`static class`	`SystemPropertyChangeEnvironmentFacet.SystemPropertyChangesBuilder`	Builder class intended to simplify creating SystemPropertyChange EnvironmentFacets.

Field Summary
- Fields inherited from class org.codehaus.mojo.jaxb2.shared.environment.AbstractLogAwareFacet
  log

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SystemPropertyChangeEnvironmentFacet.SystemPropertyChangesBuilder`	`getBuilder(org.apache.maven.plugin.logging.Log mavenLog)`	Creates a SystemPropertyChangesBuilder which uses the supplied active Maven Log.
`void`	`restore()`	Restores the original Environment, implying that the change performed in `setup()` method are restored to the state before the setup method was called.
`void`	`setup()`	Sets up this Environment, inferring temporary changes to environment variables or conditions.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - setup
```
public void setup()
```
    Sets up this Environment, inferring temporary changes to environment variables or conditions. The changes must be reversible, and should be restored to their original values in the restore() method.
  - restore
```
public void restore()
```
    Restores the original Environment, implying that the change performed in setup() method are restored to the state before the setup method was called.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A Debug string representation of this SystemPropertyChangeEnvironmentFacet.
  - getBuilder
```
public static SystemPropertyChangeEnvironmentFacet.SystemPropertyChangesBuilder getBuilder(org.apache.maven.plugin.logging.Log mavenLog)
```
    Creates a SystemPropertyChangesBuilder which uses the supplied active Maven Log.
    
    Parameters:
    
    mavenLog - The active Maven Log to be used by all SystemPropertyChange objects created by this SystemPropertyChangesBuilder.
    
    Returns:
    
    A SystemPropertyChangesBuilder ready for use.