Skip to content

Latest commit

 

History

History
114 lines (97 loc) · 6.39 KB

readme.md

File metadata and controls

114 lines (97 loc) · 6.39 KB
Raw

Test Status Maven Central

General description

JTrim is a collection of multiple modules with various purpose. Including the following:

  • Cancellation support (similar to .NET's)
  • Executor framework with better cancellation support and native support for Java 8's CompletionStage. Also, there are many kinds of executor implementations.
  • Synchronous producer-consumer handling.
  • Generic event handling utilities.
  • Generic property handling (properties with change listeners).
  • Support for automatic UI state management.
  • Better support for background task processing in UI applications.
  • Asynchronous data retrieval (mostly aiming UIs).

For understanding the documentation of JTrim, you should read concurrency.md. You may also want to browse the API doc of all modules, or on javadoc.io.

All released modules have a very high test coverage and all public API is documented (though there are typos to be fixed).

Using JTrim

JTrim binaries are hosted in Central.

Example usage in Gradle

repositories {
    mavenCentral()
}
dependencies {
    implementation "org.jtrim2:jtrim-executor:${jtrimVersion}"
}

Example usage in Maven

<dependencies>
    <dependency>
        <groupId>org.jtrim2</groupId>
        <artifactId>jtrim-executor</artifactId>
    </dependency>
</dependencies>

List of modules

All modules have the group id: "org.jtrim2"

  • jtrim-access: Manages resources between cooperating code. This module was designed to provide support for UIs to manage what tasks are allowed to run and what not.
  • jtrim-cache: Provides basic caching support. The caching was designed for the jtrim-query module and is not a generic caching library. It is best thought of as the generalization of weak and soft references.
  • jtrim-collections: Adds various collection utilities supplementing the JDK.
  • jtrim-concurrent: Provides cancellation support, generic event handling and some basic concurrency utilities.
  • jtrim-event-track: Allows event handling where it is possible to track the causes of events.
  • jtrim-executor: A new executor framework with better cancellation, and native support for Java 8's CompletionStage.
  • jtrim-image: Provides small utilities for working with BufferedImage.
  • jtrim-image-query: This module provides support to load images asynchronously using ImageIO.
  • jtrim-image-transform: Provides common image transformation for BufferedImage. The transformation assumes that there is a fixed size destination (like a UI component).
  • jtrim-logs: Provides small utilities for java.util.logging, mostly helping testing logging.
  • jtrim-property: Provides generic property handling utilities (properties with change listeners).
  • jtrim-query: Provides asynchronous query support.
  • jtrim-stream: Provides conveniently implementable yet powerful stream support (instead of Java's Stream API).
  • jtrim-swing-component: Provides Swing components with support for rendering in the background.
  • jtrim-swing-concurrent: Provides support for background task execution for Swing applications. This module simply extends the support provided by the jtrim-ui-concurrent module.
  • jtrim-swing-property: Provides utility to map Swing properties to JTrim based properties and to bind properties to prevent unwanted UI access.
  • jtrim-swing-query: Provides support for asynchronous queries for Swing applications. This module simply extends the support provided by the jtrim-ui-property module.
  • jtrim-task-graph: Allows executing a computation graph with various resource constraints.
  • jtrim-ui-concurrent: Provides support for background task execution for UI applications. This module builds on the support provided by the jtrim-access module to allow you to prevent access to UI or the prevent starting the background task.
  • jtrim-ui-query: Provides support for asynchronous queries for UI applications. This module builds on the support provided by the jtrim-access module to allow you to prevent access to UI or the prevent starting the asynchronous query.
  • jtrim-utils: This module provides some very basic utility used by all JTrim modules.