+
package org.springframework.cloud.contract.verifier.builder;
+
+import java.nio.file.Path;
+import java.util.Collection;
+
+import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties;
+import org.springframework.cloud.contract.verifier.file.ContractMetadata;
+
+/**
+ * Builds a single test.
+ *
+ * @since 1.1.0
+ */
+public interface SingleTestGenerator {
+
+ /**
+ * Creates contents of a single test class in which all test scenarios from the
+ * contract metadata should be placed.
+ * @param properties - properties passed to the plugin
+ * @param listOfFiles - list of parsed contracts with additional metadata
+ * @param className - the name of the generated test class
+ * @param classPackage - the name of the package in which the test class should be
+ * stored
+ * @param includedDirectoryRelativePath - relative path to the included directory
+ * @return contents of a single test class
+ * @deprecated use{@link SingleTestGenerator#buildClass(ContractVerifierConfigProperties, Collection, String, GeneratedClassData)}
+ */
+ @Deprecated
+ String buildClass(ContractVerifierConfigProperties properties,
+ Collection<ContractMetadata> listOfFiles, String className,
+ String classPackage, String includedDirectoryRelativePath);
+
+ /**
+ * Creates contents of a single test class in which all test scenarios from the
+ * contract metadata should be placed.
+ * @param properties - properties passed to the plugin
+ * @param listOfFiles - list of parsed contracts with additional metadata
+ * @param generatedClassData - information about the generated class
+ * @param includedDirectoryRelativePath - relative path to the included directory
+ * @return contents of a single test class
+ */
+ default String buildClass(ContractVerifierConfigProperties properties,
+ Collection<ContractMetadata> listOfFiles,
+ String includedDirectoryRelativePath, GeneratedClassData generatedClassData) {
+ String className = generatedClassData.className;
+ String classPackage = generatedClassData.classPackage;
+ String path = includedDirectoryRelativePath;
+ return buildClass(properties, listOfFiles, className, classPackage, path);
+ }
+
+ /**
+ * Extension that should be appended to the generated test class. E.g. {@code .java}
+ * or {@code .php}
+ * @param properties - properties passed to the plugin
+ */
+ @Deprecated
+ String fileExtension(ContractVerifierConfigProperties properties);
+
+ class GeneratedClassData {
+
+ public final String className;
+
+ public final String classPackage;
+
+ public final Path testClassPath;
+
+ public GeneratedClassData(String className, String classPackage,
+ Path testClassPath) {
+ this.className = className;
+ this.classPackage = classPackage;
+ this.testClassPath = testClassPath;
+ }
+
+ }
+
+}
+
+