Result Library Benchmarks

This project contains some benchmarks for the Result Library for Java.

You may want to visualize the latest report.

Benchmark Scenarios

There are simple and complex scenarios to compare performance when using results versus when using exceptions.

Simple Scenarios

The first scenarios compare the most basic usage: a method that returns a String or fails, depending on a given int parameter:

Using Exceptions

public String usingExceptions(int number) throws SimpleException {
  if (number < 0) {
    throw new SimpleException(number);
  }
  return "ok";
}

Using Results

public Result<String, SimpleFailure> usingResults(int number) {
  if (number < 0) {
    return Results.failure(new SimpleFailure(number));
  }
  return Results.success("ok");
}

Complex Scenarios

The next scenarios do something a little bit more elaborate: a method invokes the previous method to retrieve a String; if successful, then converts it to upper case; otherwise transforms the "simple" error into a "complex" error.

Using Exceptions

public String usingExceptions(int number) throws ComplexException {
  try {
    return simple.usingExceptions(number).toUpperCase();
  } catch (SimpleException e) {
    throw new ComplexException(e);
  }
}

Using Results

public Result<String, ComplexFailure> usingResults(int number) {
  return simple.usingResults(number)
    .map(String::toUpperCase, ComplexFailure::new);
}

Getting Started

Important

The report you can see here was generated on a GitHub-hosted runner using the latest Ubuntu image and the latest Azul Zulu OpenJDK version. Performance measurements may vary depending on different factors such as architecture, operating system, or Java virtual machine. Please remember that you should run your own benchmarks to make informed decisions for your specific project.

To run the JMH benchmarks locally, execute this command:

./gradlew jhm

Once they are complete, a report will be generated automatically by JMH Visualizer.

start ./benchmark/build/reports/jmh/index.html

Author

Copyright 2024 Guillermo Calvo.

License

This library is licensed under the Apache License, Version 2.0 (the "License"); you may not use it except in compliance with the License.

You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and limitations under the License.

Permitted:

• Commercial Use: You may use this library and derivatives for commercial purposes.
• Modification: You may modify this library.
• Distribution: You may distribute this library.
• Patent Use: This license provides an express grant of patent rights from contributors.
• Private Use: You may use and modify this library without distributing it.

Required:

• License and Copyright Notice: If you distribute this library you must include a copy of the license and copyright notice.
• State Changes: If you modify and distribute this library you must document changes made to this library.

Forbidden:

• Trademark use: This license does not grant any trademark rights.
• Liability: The library author cannot be held liable for damages.
• Warranty: This library is provided without any warranty.