Skip to content

Getting started

Requirements

JDK 25 or later. Zazr has no runtime dependency.

Add the dependency

Nothing is released yet: the snapshots of main are on Maven Central's snapshot repository, and the API changes between them.

<repositories>
    <repository>
        <id>central-portal-snapshots</id>
        <url>https://central.sonatype.com/repository/maven-snapshots/</url>
        <snapshots><enabled>true</enabled></snapshots>
        <releases><enabled>false</enabled></releases>
    </repository>
</repositories>

<dependency>
    <groupId>com.guizmaii</groupId>
    <artifactId>zazr-core</artifactId>
    <version>0.1.0-SNAPSHOT</version>
</dependency>

repositories {
    maven("https://central.sonatype.com/repository/maven-snapshots/")
}

dependencies {
    implementation("com.guizmaii:zazr-core:0.1.0-SNAPSHOT")
}

If your project uses Java modules (a module-info.java), add requires com.guizmaii.zazr; to it. Projects without a module-info.java need nothing more.

Where things are

Package Types
com.guizmaii.zazr.control Option, Either, Try, Validation
com.guizmaii.zazr.collection Vector, NonEmptyVector, List, Queue, Stream, HashSet, LinkedHashSet, TreeSet, HashMap, LinkedHashMap, TreeMap
com.guizmaii.zazr Lazy, Tuple and Tuple0 to Tuple8, Function3 to Function8, the Checked* functional interfaces

List and Stream share their names with java.util.List and java.util.stream.Stream: import the Zazr ones and spell the JDK ones out, as the examples on this site do.

Five minutes of Zazr

A value that may be absent is an Option. It never holds null; use ofNullable to wrap a value that may be null.

Option<String> name = Option.ofNullable(System.getenv("ZAZR_DOCS_UNSET"));
String greeting = name.map(n -> "hello " + n).getOrElse("hello stranger");
// "hello stranger"

Option, Either, Try and Validation are sealed interfaces of records, so a switch over them is exhaustive and can take the records apart.

Either<String, Integer> parsed = Either.right(42);
String text = switch (parsed) {
    case Right(var n) -> "got " + n;
    case Left(var error) -> "failed: " + error;
};

A computation that may throw is a Try; catchAll recovers.

Try<Integer> port = Try.of(() -> Integer.parseInt("80a"));
int value = port.catchAll(error -> 8080).get();
// 8080

Vector is the default sequence. Every operation returns a new Vector, and access by index takes a few steps at any size.

Vector<Integer> numbers = Vector.of(1, 2, 3, 4);
Vector<Integer> doubled = numbers.map(n -> n * 2).append(10);
int third = doubled.get(2);
// doubled is Vector(2, 4, 6, 8, 10), third is 6

Next

  • Control types: Option, Either, Try and Lazy in detail.
  • Validation: checks that report every error at once.
  • Collections: which collection to choose, and what each operation costs.