org.junitpioneer.jupiter.resource.New 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.resource;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @New} is used to create a new resource.
*
* It is part of the "resources" JUnit Jupiter extension, which pertains to anything that needs
* to be injected into tests and which may need to be started up or torn down. Temporary
* directories are a common example.
*
*
This class is intended for users.
*
* For more details and examples, see
* the documentation on resources
* and temporary directories.
*
* @since 1.9.0
* @see Resource
* @see ResourceFactory
*/
@ExtendWith(ResourceExtension.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.PARAMETER, ElementType.ANNOTATION_TYPE })
public @interface New {
/**
* The class of the resource factory to get the resource from.
*/
Class> value();
/**
* An array of string arguments to pass to the resource factory.
*
* Refer to the documentation of the resource factory implementation that is passed to this
* annotation for more information on which arguments are accepted and what they do.
*/
String[] arguments() default {};
}