/julielab-java-utilities

A collection of small commonly useful utilities and helpers for Java.

Primary LanguageJavaBSD 2-Clause "Simplified" LicenseBSD-2-Clause

julielab-java-utilities

A collection of small commonly useful utilities and helpers for Java. This project should be extended by other commonly useful classes and methods.

Feel free to add more generally useful libraries here! When you do (and please do!), kindly consider the following:

BEFORE EXTENDING this project, please be (reasonably) sure that the desired functionality is not already contained in another libarary. Candidates to check are

Also, please try to keep the dependencies of the project as small as possible. Whenever external libraries are needed only for some specific functionality, set the respective dependencies to the providedscope and add a respective note to this readme.

Classes Overview

CLIInteractionUtilities.java

  • Helper methods to read from the command line
  • With a message to print or without
  • Restricted to boolean yes/no answers.

Color.java

  • A few ANSI color code constants.

CompressionUtilities.java

  • NOTE: requires the dependency org.rauschig:jarchivelib:1.2.0to exist on the classpath. This dependency is not resolved transitively from this project.
  • has a method to extract archive files with automatic archive format determination

ConfigurationUtilities.java

  • NOTE: requires the dependency org.apache.commons:commons-configuration2:2.2, commons-beanutils:commons-beanutils:1.9.3and commons-jxpath:commons-jxpath:1.3to exist on the classpath. This dependency is not resolved transitively from this project.
  • Helper methods for the apache commons configuration 2 project
  • configuration parameter checking
  • configuration parameter path creation
  • configuration file reading

IOStreamUtilities

  • Method to get a UTF-8 encoded reader from an InputStream
  • Method to get a list of UTF-8 encoded lines from an InputStream

FileUtilities.java

  • Helper methods to read or write files
  • Automatically handles regular or gzipped files
  • Convention: A File instance with a name that ends with .gz or .gzip Is handled like a gzipped file automatically, in reading and writing.
  • Method to create a JAR file from an array of given files
  • Method to add a file into an existing JAR
  • Method to find a (file) resource via file path, URI or on the classpath.

JarLoader.java

  • NOTE requires the dependency net.bytebuddy:byte-buddy-agent:1.7.9 to exist on the classpath. This dependency is not resolved transitively from this project.
  • Allows to load JAR files during runtime
  • Exploits the fact that the system class loader is an URIClassLoader` until Java 8
  • Automatically detects Java version to pick the correct JAR loading strategy
  • Beginning with Java 9, uses the java.lang.instrument package and employs the Agent class included in this project
    • Needs to determine the file path of the JAR containing the Agent class
    • This JAR needs to have a META-INF/MANIFEST.MF file with the entry Agent-Class: de.julielab.java.utilities.classpath.Agent
    • The julielab-java-utilities JAR is searched on the classpath for this purpose.
    • In case of an uber JAR or fat JAR (e.g. through the Maven assembly or shadow plugins), the uber JAR itself is pointed to. The uber JAR must then have the manifest entry as explained above.

prerequisites.PrerequisiteChecker

  • Simple to use API to check parameter values for being not null or not empty. Automatically generates an error report if checks fail via an `IllegalArgumentException.
  • Example: PrerequisiteChecker.checkThat().notNull(ob1, ob2).notEmpty(coll).withNames("ob1", "ob2", "coll").execute()
  • Is deactivated by default: No checks will be performed unless the Java system property de.julielab.prerequisitechecksenabled is set to true.
  • Can be used with the Supplier interface. This allows to quickly check a path within a given object, e.g. PrerequisiteChecker.checkThat().notNull(ob).notNull(() -> ob.prop1).notNull(() -> ob.prop1.prop2).withNames("Base object), "Property 1", "Property 2).execute()

cache.*

  • NOTE requires the dependency org.mapdb:mapdb:3.0.7for the actual cache implementation. This dependency is not resolved transitively from this project.
  • The CacheServiceis a singleton that is configured once per application. It then offers CacheAccessobjects for caching.
  • The CacheServiceis configured via a CacheConfigurationobject. Possible settings include persistent caching, cache size, usage of a in-memory cache in addition to persistent caching, read-only access and the usage of remote caching (see the CachServerbelow).
  • The CacheAccessobjects provide a simple interface to an underlying MapDBcache. The ´CacheMapSettingscan be used to pass configuration to theMapDB`implementation.
  • This package also offers the CacheServerwhich is a simple HTTP server to encapsulate persistent caches. The main advantage is that multiple clients can then access the same persistent cache. This is not possible otherwise because the cache files can only be opened by a single JVM. When setting remote caching to the CacheConfigurationand specifying host and HTTP port, the CacheAccessintances returned by the CacheServiceare RemoteCacheAccessobjects. Otherwise, nothing is different from using local caching.

index.*

  • NOTE requires the dependency org.apache.lucene:lucene-core:8.9.0 commons-io:commons-io:2.7 for the actual index implementation. This dependency is not resolved transitively from this project.
  • Useful when a large map is required that exceeds memory availability
  • Indexes keys and values in map-fashion into a Lucene index
  • Offers simple methods for retrieval
  • Offers in-memory Guava caching for speedup

Span Utilities

  • NOTE requires the dependency org.apache.commons:org.apache.commons:3.8.1 for the Range class. This dependency is not resolved transitively from this project.
  • Helper classes for objects that cover some kind of integer-valued span
    • e.g. word spans, character spans, time spans
  • Particularly useful when span-objects are sought that overlap with a given span.
  • de.julielab.java.utilities.spanutils.OffsetMap maps integer ranges to arbitrary objects, e.g. text annotations. It returns a overlapping-range-restricted subset of itself on request and can return contained objects overlapping a given range.
  • de.julielab.java.utilities.spanutils.OffsetSet stores a set of ranges and allows to retrieve the first range in the set that overlaps a given range.
  • de.julielab.java.utilities.spanutils.SpanOffsetSet this is basically the OffsetSet but accepts objects implementing Span, allowing for more general objects.

StringIteratorInputStream

  • Creates an InputStream that is constructed from an iterator of String
  • Useful when an API requires an InputStream and the String input is very large and should not be read completely into memory before writing the stream to file or similar scenarios.
  • Taken from https://stackoverflow.com/a/62160797/1314955

UriUtilities.java

  • Get InputStreams and Readers from java.net.URI
  • Automatically handles regular or gzipped files, analogous to FileUtilities.java