https://github.com/digital-preservation/utf8-validator
UTF-8 Validator
https://github.com/digital-preservation/utf8-validator
charset unicode utf-8 utf8-validator validator
Last synced: 26 days ago
JSON representation
UTF-8 Validator
- Host: GitHub
- URL: https://github.com/digital-preservation/utf8-validator
- Owner: digital-preservation
- License: bsd-3-clause
- Created: 2013-11-19T12:59:25.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-03-24T12:02:22.000Z (about 2 years ago)
- Last Synced: 2025-05-07T15:19:56.333Z (26 days ago)
- Topics: charset, unicode, utf-8, utf8-validator, validator
- Language: Java
- Size: 120 KB
- Stars: 19
- Watchers: 8
- Forks: 7
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
UTF-8 Validator
===============
A UTF-8 Validation Tool which may be used as either a command line tool or as a library embedded in your own program.
Released under the [BSD 3-Clause Licence](http://opensource.org/licenses/BSD-3-Clause).
[](https://github.com/digital-preservation/utf8-validator/actions?query=workflow%3ACI)
[](https://search.maven.org/search?q=g:uk.gov.nationalarchives)
Use from the Command Line
-------------------------
You can either download the application from [here](https://search.maven.org/remotecontent?filepath=uk/gov/nationalarchives/utf8-validator/1.2/utf8-validator-1.2-application.zip) or [build from the source code](#building-from-source-code). You should extract this ZIP file to the place on your computer where you keep your applications. You can then run either `bin/validate.sh` (Linux/Mac/Unix) or `bin\validate.bat` (Windows).
For example, to report all validation errors:
```bash
$ cd /opt/utf8-validator-1.2
$ bin/validate /tmp/my-file.txt
```
For example to report the first validation error and exit:
```bash
$ cd /opt/utf8-validator-1.2
$ bin/validate.sh --fail-fast /tmp/my-file.txt
```
Command Line Exit Codes
-----------------------
* **0** Success
* **1** Invalid Arguments provided to the application
* **2** File was not UTF-8 Valid
* **4** IO Error, e.g. could not read file
Use as a Library
----------------
The UTF-8 Validator is written in Java and may be easily used from any Java (Scala, Clojure, JVM Language etc) application. We are using the Maven build system, and our artifacts have been published to [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22uk.gov.nationalarchives%22).
If you are using Maven, you can simply add this to the dependencies section of your pom.xml:
```xml
uk.gov.nationalarchives
utf8-validator
1.2
```
Alternatively if you are using Sbt, you can add this to your library dependencies:
```scala
"uk.gov.nationalarchives" % "utf8-validator" % "1.2"
```
To use the Library you need to implement the very simple interface `uk.gov.nationalarchives.utf8.validator.ValidationHandler` (or you could use `uk.gov.nationalarchives.utf8.validator.PrintingValidationHandler` if it suits you). The interface has a single method which is called whenever a validator finds a validation error. You can then instantiate `Utf8Validator` and validate from either a `java.io.File` or `java.io.InputStream`. For example:
```java
ValidationHandler handler = new ValidationHandler() {
@Override
public void error(final String message, final long byteOffset) throws ValidationException {
System.err.println("[Error][@" + byteOffset + "] " + message);
};
};
File f = ... //your file here
new Utf8Validator(handler).validate(f);
```
Building from Source Code
--------------------------
* Git clone the repository from https://github.com/digital-preservation/utf8-validator.git
* Build using [Maven](http://maven.apache.org), by running `mvn package` you will then find a ZIP of the compiled application in `target/utf8-validator-1.2-application.zip`.