org.junitpioneer.jupiter.ClearSystemProperty Maven / Gradle / Ivy
/*
* Copyright 2015-2020 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v2.0 which
* accompanies this distribution and is available at
*
* http://www.eclipse.org/legal/epl-v20.html
*/
package org.junitpioneer.jupiter;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @ClearSystemProperty} is a JUnit Jupiter extension to clear the value
* of a system property for a test execution.
*
* The key of the system property to be cleared must be specified via
* {@link #key()}. After the annotated element has been executed, After the
* annotated method has been executed, the initial default value is restored.
*
* {@code ClearSystemProperty} is repeatable and can be used on the method and
* on the class level. If a class is annotated, the configured property will be
* cleared for all tests inside that class.
*
* For more details and examples, see
* the documentation on @ClearSystemProperty and @SetSystemProperty.
*
*
* @since 0.5
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.TYPE })
@Repeatable(ClearSystemProperty.ClearSystemProperties.class)
@ExtendWith(SystemPropertyExtension.class)
public @interface ClearSystemProperty {
/**
* The key of the system property to be cleared.
*/
String key();
/**
* Containing annotation of repeatable {@code @ClearSystemProperty}.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.TYPE })
@ExtendWith(SystemPropertyExtension.class)
@interface ClearSystemProperties {
ClearSystemProperty[] value();
}
}