Giter Site home page Giter Site logo

e2immu: Practical Immutability for Java

More information on the project website https://www.e2immu.org.

About the project

e2immu is a static code analyser for modern Java. As for every code analyser, it aims to help you write better code by making you aware of unwanted constructs, possible causes for exceptions etc. Even if it includes many "standard" warnings, e2immu is not a general code analyser: it focuses on modification and immutability. It is able to detect that classes are immutable in practice, or not, and why they are not.

It also provides a practical definition of such immutability, called "effective immutability". It can detect that classes are eventually immutable, i.e., they become effectively immutable after an initialisation phase. It provides some out-of-the-box classes that help with making your own code eventually immutable.

Ideally, the results of the analyser are shown directly in your programming environment. At the moment, a plugin for IntelliJ is in development. Support for Eclipse and Visual Studio Code are planned.

The following links point towards in-depth reading material:

Current status

TL;DR: The e2immu analyser is not yet ready for general use. Please follow the project on GitHub to stay in touch if you "just" want to use the analyser.

All core concepts are solid, however. There is a full tutorial about the how and why of effective and eventual immutability, and all related properties. There are more than 250 code snippets running green, so there is a ton of example material already present. You can already improve your code by introducing eventually immutable constructs. The analyser is "nothing but" a support tool to help you along.

In descending order of priority, we are now focusing on

  • fixing bugs and crashes;
  • enabling the analyser to process its own code base. This partially depends on advances in the JavaParser library, since the analyser uses Java 16 syntax and constructs;
  • providing one working, informative IDE plugin;
  • determining a selection of the most important Java APIs, and providing annotations for them.

As soon as these four milestones have been met, the analyser will be promoted as "ready for general use".

e2immu's Projects

e2immu icon e2immu

The e2immu project: effective and eventual immutability: annotations and a code analyser

e2immu-support icon e2immu-support

Support classes and annotations for the e2immu static code analyser

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.