Skip to content

Java API interface updated to give results from implementation classes. #630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sparkhi merged 2 commits into from
Jan 13, 2026
Merged

Java API interface updated to give results from implementation classes. #630

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
959123a
Java API interface updated to give results from implementation classes.
sparkhi Jan 12, 2026
c1bc083
nested calls simplified by extracting request the first time
sparkhi Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Example Java code of using the CSV Validator through the Java API:
csvReader, csvSchemaReader
)

Result result = validateWithStringNames
List<FailMessage> messages = validateWithStringNames
.usingCsvEncoding(csvEncoding, validateCsvEncoding) // should only be `true` if using UTF-8 encoding, otherwise it will throw an exception
.usingCsvSchemaEncoding(csvSchemaEncoding)
.usingFailFast(failFast)
Expand All @@ -85,9 +85,8 @@ Example Java code of using the CSV Validator through the Java API:
.usingProgress(progress)
.usingSkipFileChecks(skipFileChecks)
.usingMaxCharsPerCell(maxCharsPerCell)
.runValidation();

List<FailMessage> messages = ((CsvValidatorJavaBridge.ValidationResult)(result)).errors();
.runValidation()
.getErrors();

if(messages.isEmpty()) {
System.out.println("All worked OK");
Expand Down
21 changes: 0 additions & 21 deletions ...idator-java-api/src/main/java/uk/gov/nationalarchives/csv/validator/api/java/Request.java
View file
Open in desktop

This file was deleted.

5 changes: 2 additions & 3 deletions ...lidator-java-api/src/main/java/uk/gov/nationalarchives/csv/validator/api/java/Result.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@
*/
package uk.gov.nationalarchives.csv.validator.api.java;

import java.util.ArrayList;
import java.util.List;

public interface Result {
ArrayList<FailMessage> errors = new ArrayList<>();
Request validatorRequest = null;
List<FailMessage> getErrors();
}
14 changes: 9 additions & 5 deletions ...rc/main/scala/uk/gov/nationalarchives/csv/validator/api/java/CsvValidatorJavaBridge.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,13 @@ object CsvValidatorJavaBridge {
case SFailMessage(SchemaDefinitionError, msg, lineNr, columnIdx) => new ErrorMessage(msg, lineNr.getOrElse(-1), columnIdx.getOrElse(-1)).asInstanceOf[FailMessage]
}

case class ValidationResult(errors: JList[FailMessage], validatorRequest: ValidationRequest) extends Result
case class ValidationRequest(csvFile: String, csvEncoding: Charset, validateCsvEncoding: Boolean, csvSchemaFile: String, csvSchemaEncoding: Charset, validateCsvSchemaEncoding: Boolean, failFast: Boolean, pathSubstitutionsList: JList[Substitution], enforceCaseSensitivePathChecks: Boolean, trace: Boolean, progress: ProgressCallback, skipFileChecks: Boolean, maxCharsPerCellLimit: Int) extends Request

case class ReaderValidationResult(errors: JList[FailMessage], validatorRequest: ReaderValidationRequest) extends Result
case class ReaderValidationRequest(csvReader: JReader, csvSchemaReader: JReader, failFast: Boolean, pathSubstitutionsList: JList[Substitution], enforceCaseSensitivePathChecks: Boolean, trace: Boolean, progress: ProgressCallback, skipFileChecks: Boolean, maxCharsPerCellLimit: Int) extends Request
case class ValidationResult(errors: JList[FailMessage], validatorRequest: ValidationRequest) extends Result {
override def getErrors: JList[FailMessage] = errors
}
case class ValidationRequest(csvFile: String, csvEncoding: Charset, validateCsvEncoding: Boolean, csvSchemaFile: String, csvSchemaEncoding: Charset, validateCsvSchemaEncoding: Boolean, failFast: Boolean, pathSubstitutionsList: JList[Substitution], enforceCaseSensitivePathChecks: Boolean, trace: Boolean, progress: ProgressCallback, skipFileChecks: Boolean, maxCharsPerCellLimit: Int)

case class ReaderValidationResult(errors: JList[FailMessage], validatorRequest: ReaderValidationRequest) extends Result {
override def getErrors: JList[FailMessage] = errors
}
case class ReaderValidationRequest(csvReader: JReader, csvSchemaReader: JReader, failFast: Boolean, pathSubstitutionsList: JList[Substitution], enforceCaseSensitivePathChecks: Boolean, trace: Boolean, progress: ProgressCallback, skipFileChecks: Boolean, maxCharsPerCellLimit: Int)
}
92 changes: 46 additions & 46 deletions ...va-api/src/test/java/uk/gov/nationalarchives/csv/validator/api/java/CsvValidatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,33 +24,33 @@ public class CsvValidatorTest {
@Test
public void defaultValuesAreUsedWhenUsingTextFileMethod() {
Result result = new CsvValidator.ValidatorBuilder("csvFile", "csvSchema").runValidation();
CsvValidatorJavaBridge.ValidationResult validatorRequest = (CsvValidatorJavaBridge.ValidationResult) result;
Assert.assertEquals("csvFile", validatorRequest.validatorRequest().csvFile());
Assert.assertEquals(StandardCharsets.UTF_8, validatorRequest.validatorRequest().csvEncoding());
Assert.assertEquals("csvSchema", validatorRequest.validatorRequest().csvSchemaFile());
Assert.assertEquals(StandardCharsets.UTF_8, validatorRequest.validatorRequest().csvSchemaEncoding());
Assert.assertFalse(validatorRequest.validatorRequest().failFast());
Assert.assertEquals(new ArrayList<Substitution>(), validatorRequest.validatorRequest().pathSubstitutionsList());
Assert.assertFalse(validatorRequest.validatorRequest().enforceCaseSensitivePathChecks());
Assert.assertFalse(validatorRequest.validatorRequest().trace());
Assert.assertNull(validatorRequest.validatorRequest().progress());
Assert.assertFalse(validatorRequest.validatorRequest().skipFileChecks());
Assert.assertEquals(4096, validatorRequest.validatorRequest().maxCharsPerCellLimit());
CsvValidatorJavaBridge.ValidationRequest validationRequest = ((CsvValidatorJavaBridge.ValidationResult) result).validatorRequest();
Assert.assertEquals("csvFile", validationRequest.csvFile());
Assert.assertEquals(StandardCharsets.UTF_8, validationRequest.csvEncoding());
Assert.assertEquals("csvSchema", validationRequest.csvSchemaFile());
Assert.assertEquals(StandardCharsets.UTF_8, validationRequest.csvSchemaEncoding());
Assert.assertFalse(validationRequest.failFast());
Assert.assertEquals(new ArrayList<Substitution>(), validationRequest.pathSubstitutionsList());
Assert.assertFalse(validationRequest.enforceCaseSensitivePathChecks());
Assert.assertFalse(validationRequest.trace());
Assert.assertNull(validationRequest.progress());
Assert.assertFalse(validationRequest.skipFileChecks());
Assert.assertEquals(4096, validationRequest.maxCharsPerCellLimit());
}

@Test
public void defaultValuesAreUsedWhenUsingReaderMethod() {
Result result = new CsvValidator.ValidatorBuilder(csvFileReader, csvSchemaReader).runValidation();
CsvValidatorJavaBridge.ReaderValidationResult validatorRequest = (CsvValidatorJavaBridge.ReaderValidationResult) result;
Assert.assertEquals(csvFileReader, validatorRequest.validatorRequest().csvReader());
Assert.assertEquals(csvSchemaReader, validatorRequest.validatorRequest().csvSchemaReader());
Assert.assertFalse(validatorRequest.validatorRequest().failFast());
Assert.assertEquals(new ArrayList<Substitution>(), validatorRequest.validatorRequest().pathSubstitutionsList());
Assert.assertFalse(validatorRequest.validatorRequest().enforceCaseSensitivePathChecks());
Assert.assertFalse(validatorRequest.validatorRequest().trace());
Assert.assertNull(validatorRequest.validatorRequest().progress());
Assert.assertFalse(validatorRequest.validatorRequest().skipFileChecks());
Assert.assertEquals(4096, validatorRequest.validatorRequest().maxCharsPerCellLimit());
CsvValidatorJavaBridge.ReaderValidationRequest validationRequest = ((CsvValidatorJavaBridge.ReaderValidationResult) result).validatorRequest();
Assert.assertEquals(csvFileReader, validationRequest.csvReader());
Assert.assertEquals(csvSchemaReader, validationRequest.csvSchemaReader());
Assert.assertFalse(validationRequest.failFast());
Assert.assertEquals(new ArrayList<Substitution>(), validationRequest.pathSubstitutionsList());
Assert.assertFalse(validationRequest.enforceCaseSensitivePathChecks());
Assert.assertFalse(validationRequest.trace());
Assert.assertNull(validationRequest.progress());
Assert.assertFalse(validationRequest.skipFileChecks());
Assert.assertEquals(4096, validationRequest.maxCharsPerCellLimit());
}

@Test
Expand Down Expand Up @@ -79,19 +79,19 @@ public void correctValuesArePassedIntoValidateMethodUsingTextFileMethod() throws
.usingSkipFileChecks(true)
.usingMaxCharsPerCell(8096)
.runValidation();
CsvValidatorJavaBridge.ValidationResult validatorRequest = (CsvValidatorJavaBridge.ValidationResult) result;
Assert.assertEquals("csvFile", validatorRequest.validatorRequest().csvFile());
Assert.assertEquals(StandardCharsets.ISO_8859_1, validatorRequest.validatorRequest().csvEncoding());
Assert.assertEquals("csvSchema", validatorRequest.validatorRequest().csvSchemaFile());
Assert.assertEquals(StandardCharsets.ISO_8859_1, validatorRequest.validatorRequest().csvSchemaEncoding());
Assert.assertTrue(validatorRequest.validatorRequest().failFast());
Assert.assertEquals("fromPath", validatorRequest.validatorRequest().pathSubstitutionsList().get(0).getFrom());
Assert.assertEquals("toPath", validatorRequest.validatorRequest().pathSubstitutionsList().get(0).getTo());
Assert.assertTrue(validatorRequest.validatorRequest().enforceCaseSensitivePathChecks());
Assert.assertTrue(validatorRequest.validatorRequest().trace());
Assert.assertEquals(progressCallback, validatorRequest.validatorRequest().progress());
Assert.assertTrue(validatorRequest.validatorRequest().skipFileChecks());
Assert.assertEquals(8096, validatorRequest.validatorRequest().maxCharsPerCellLimit());
CsvValidatorJavaBridge.ValidationRequest validationRequest = ((CsvValidatorJavaBridge.ValidationResult) result).validatorRequest();
Assert.assertEquals("csvFile", validationRequest.csvFile());
Assert.assertEquals(StandardCharsets.ISO_8859_1, validationRequest.csvEncoding());
Assert.assertEquals("csvSchema", validationRequest.csvSchemaFile());
Assert.assertEquals(StandardCharsets.ISO_8859_1, validationRequest.csvSchemaEncoding());
Assert.assertTrue(validationRequest.failFast());
Assert.assertEquals("fromPath", validationRequest.pathSubstitutionsList().get(0).getFrom());
Assert.assertEquals("toPath", validationRequest.pathSubstitutionsList().get(0).getTo());
Assert.assertTrue(validationRequest.enforceCaseSensitivePathChecks());
Assert.assertTrue(validationRequest.trace());
Assert.assertEquals(progressCallback, validationRequest.progress());
Assert.assertTrue(validationRequest.skipFileChecks());
Assert.assertEquals(8096, validationRequest.maxCharsPerCellLimit());
}

@Test
Expand All @@ -109,17 +109,17 @@ public void correctValuesArePassedIntoValidateMethodUsingReaderMethod() {
.usingMaxCharsPerCell(16096)
.runValidation();

CsvValidatorJavaBridge.ReaderValidationResult validatorRequest = (CsvValidatorJavaBridge.ReaderValidationResult) result;
Assert.assertEquals(csvFileReader, validatorRequest.validatorRequest().csvReader());
Assert.assertEquals(csvSchemaReader, validatorRequest.validatorRequest().csvSchemaReader());
Assert.assertTrue(validatorRequest.validatorRequest().failFast());
Assert.assertEquals("fromPath", validatorRequest.validatorRequest().pathSubstitutionsList().get(0).getFrom());
Assert.assertEquals("toPath", validatorRequest.validatorRequest().pathSubstitutionsList().get(0).getTo());
Assert.assertTrue(validatorRequest.validatorRequest().enforceCaseSensitivePathChecks());
Assert.assertTrue(validatorRequest.validatorRequest().trace());
Assert.assertEquals(progressCallback, validatorRequest.validatorRequest().progress());
Assert.assertTrue(validatorRequest.validatorRequest().skipFileChecks());
Assert.assertEquals(16096, validatorRequest.validatorRequest().maxCharsPerCellLimit());
CsvValidatorJavaBridge.ReaderValidationRequest validationRequest = ((CsvValidatorJavaBridge.ReaderValidationResult) result).validatorRequest();
Assert.assertEquals(csvFileReader, validationRequest.csvReader());
Assert.assertEquals(csvSchemaReader, validationRequest.csvSchemaReader());
Assert.assertTrue(validationRequest.failFast());
Assert.assertEquals("fromPath", validationRequest.pathSubstitutionsList().get(0).getFrom());
Assert.assertEquals("toPath", validationRequest.pathSubstitutionsList().get(0).getTo());
Assert.assertTrue(validationRequest.enforceCaseSensitivePathChecks());
Assert.assertTrue(validationRequest.trace());
Assert.assertEquals(progressCallback, validationRequest.progress());
Assert.assertTrue(validationRequest.skipFileChecks());
Assert.assertEquals(16096, validationRequest.maxCharsPerCellLimit());
}
}

Loading