Class SystemPropertyChangeEnvironmentFacet
java.lang.Object
org.codehaus.mojo.jaxb2.shared.environment.AbstractLogAwareFacet
org.codehaus.mojo.jaxb2.shared.environment.sysprops.SystemPropertyChangeEnvironmentFacet
- All Implemented Interfaces:
EnvironmentFacet
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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Operation definitions indicating how a System property should be changed by this EnvironmentFacet.static class
Builder class intended to simplify creating SystemPropertyChange EnvironmentFacets. -
Field Summary
FieldsFields inherited from class org.codehaus.mojo.jaxb2.shared.environment.AbstractLogAwareFacet
log
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
SystemPropertyChangeEnvironmentFacet
(org.apache.maven.plugin.logging.Log log, String key) Creates a SystemPropertyChange which will remove the supplied system property for the duration of this SystemPropertyChange.private
SystemPropertyChangeEnvironmentFacet
(org.apache.maven.plugin.logging.Log log, String key, String newValue) Creates a SystemPropertyChange which stores the current -
Method Summary
Modifier and TypeMethodDescriptionprivate boolean
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 insetup()
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.toString()
-
Field Details
-
type
-
key
-
newValue
-
originalValue
-
-
Constructor Details
-
SystemPropertyChangeEnvironmentFacet
Creates a SystemPropertyChange which will remove the supplied system property for the duration of this SystemPropertyChange. No exception will be thrown if the supplied System property key is not found in the present System.properties.- Parameters:
log
- The active Maven Log.key
- A non-null key.- See Also:
-
SystemPropertyChangeEnvironmentFacet
private SystemPropertyChangeEnvironmentFacet(org.apache.maven.plugin.logging.Log log, String key, String newValue) Creates a SystemPropertyChange which stores the current- Parameters:
log
- The active Maven Log.key
- The key of the System property managed by this SystemPropertyChange.newValue
- The new value of this SystemPropertyChange.
-
-
Method Details
-
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 therestore()
method. -
restore
public void restore()Restores the original Environment, implying that the change performed insetup()
method are restored to the state before the setup method was called. -
toString
-
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.
-
existsAsSystemProperty
-