org.junitpioneer.jupiter.DefaultTimeZone Maven / Gradle / Ivy
/*
* Copyright 2016-2022 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.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @DefaultTimeZone} is a JUnit Jupiter extension to change the value
* returned by {@link java.util.TimeZone#getDefault()} for a test execution.
*
* The {@link java.util.TimeZone} to set as the default {@code TimeZone} is
* configured by specifying the {@code TimeZone} ID as defined by
* {@link java.util.TimeZone#getTimeZone(String)}. After the annotated element
* has been executed, the default {@code TimeZone} will be restored to its
* original value.
*
* {@code @DefaultTimeZone} can be used on the method and on the class
* level. It is inherited from higher-level containers, but can only be used
* once per method or class. If a class is annotated, the configured
* {@code TimeZone} will be the default {@code TimeZone} for all tests inside
* that class. Any method level configurations will override the class level
* default {@code TimeZone}.
*
* During
* parallel test execution,
* all tests annotated with {@link DefaultTimeZone}, {@link ReadsDefaultTimeZone}, and {@link WritesDefaultTimeZone}
* are scheduled in a way that guarantees correctness under mutation of shared global state.
*
*
* For more details and examples, see
* the documentation on @DefaultLocale and @DefaultTimeZone.
*
*
* @since 0.2
* @see java.util.TimeZone#getDefault()
* @see DefaultLocale
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.TYPE })
@Inherited
@WritesDefaultTimeZone
@ExtendWith(DefaultTimeZoneExtension.class)
public @interface DefaultTimeZone {
/**
* The ID for a {@code TimeZone}, either an abbreviation such as "PST", a
* full name such as "America/Los_Angeles", or a custom ID such as
* "GMT-8:00". Note that the support of abbreviations is for JDK 1.1.x
* compatibility only and full names should be used.
*/
String value();
}