Durationformatter

Java Library minimal in size and without overhead just for formatting durations

License	The Apache Software License, Version 2.0
Categories	ORM Data
GroupId	com.github.pfichtner
ArtifactId	durationformatter
Last Version	0.1.1
Release Date	Apr 24, 2014
Type	jar
Description	Durationformatter Java Library minimal in size and without overhead just for formatting durations
Project URL	https://github.com/pfichtner/durationformatter
Source Code Management	https://github.com/pfichtner/durationformatter

Download durationformatter

Filename	Size
durationformatter-0.1.1.pom
durationformatter-0.1.1.jar	7 KB
durationformatter-0.1.1-sources.jar	4 KB
durationformatter-0.1.1-javadoc.jar	34 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.pfichtner/durationformatter/ -->
<dependency>
    <groupId>com.github.pfichtner</groupId>
    <artifactId>durationformatter</artifactId>
    <version>0.1.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.pfichtner/durationformatter/
implementation 'com.github.pfichtner:durationformatter:0.1.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.pfichtner/durationformatter/
implementation ("com.github.pfichtner:durationformatter:0.1.1")

Apache Buildr

'com.github.pfichtner:durationformatter:jar:0.1.1'

Apache Ivy

<dependency org="com.github.pfichtner" name="durationformatter" rev="0.1.1">
  <artifact name="durationformatter" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.pfichtner', module='durationformatter', version='0.1.1')
)

Scala SBT

libraryDependencies += "com.github.pfichtner" % "durationformatter" % "0.1.1"

Leiningen

[com.github.pfichtner/durationformatter "0.1.1"]

Dependencies

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.10

Project Modules

There are no modules declared in this project.

durationformatter

Java Library minimal in size and without overhead just for formatting durations

Intention

Because I could not find the 5th time i searched for an artifact just for formatting durations to strings, I started to write my own. This class should be flexible enough to cover all possible needs.

Usage

These showcases are copied from the UnitTests:

Default digit format

DurationFormatter df = DurationFormatter.DIGITS;
assertEquals("01:02:03", df.formatMillis(HOURS.toMillis(1) + MINUTES.toMillis(2) + SECONDS.toMillis(3)));

Default symbol format

DurationFormatter df = DurationFormatter.SYMBOLS;
assertEquals("792h 0min 33s", df.formatMillis(DAYS.toMillis(33) + SECONDS.toMillis(33)));

The amount of units can be limited using maximumAmountOfUnitsToShow. E.g. when having long running actions like downloads it makes no sense to generate texts like 2 days 0 hours 0 minutes 17 seconds, the information 2 days 0 hours might be enough but later, when there are only some minutes or seconds left, the text should be x minutes or x seconds, see this example

DurationFormatter df = Builder.SYMBOLS.maximum(DAYS).minimum(SECONDS).suppressZeros(LEADING).maximumAmountOfUnitsToShow(2).build();

assertEquals("3d 0h", df.formatMillis(DAYS.toMillis(3)));
assertEquals("3d 0h", df.formatMillis(DAYS.toMillis(3) + SECONDS.toMillis(1)));
assertEquals("3d 2h", df.formatMillis(DAYS.toMillis(3) + HOURS.toMillis(2) + SECONDS.toMillis(1)));
assertEquals("3d 13h", df.formatMillis(DAYS.toMillis(3) + HOURS.toMillis(12) + MINUTES.toMillis(31) + SECONDS.toMillis(1)));
assertEquals("12h 31min", df.formatMillis(HOURS.toMillis(12) + MINUTES.toMillis(31) + SECONDS.toMillis(1)));
assertEquals("31min 0s", df.formatMillis(MINUTES.toMillis(31)));
assertEquals("31min 1s", df.formatMillis(MINUTES.toMillis(31) + SECONDS.toMillis(1)));

To create your customized DurationFormatter you can use one of the predefined Builders
...there is one for digits...

DurationFormatter df  = DurationFormatter.Builder.DIGITS.minimum(TimeUnit.NANOSECONDS).maximum(MILLISECONDS)
	.stripZeros(StripMode.LEADING).build();
assertEquals("000", df.format(0, TimeUnit.NANOSECONDS));
assertEquals("999", df.format(999, TimeUnit.NANOSECONDS));
assertEquals("001:499", df.format(1499, TimeUnit.NANOSECONDS));

...and one for symbols...

DurationFormatter df = Builder.SYMBOLS.separator(", ").symbol(MINUTES, "m").valueSymbolSeparator(" ").build();
assertEquals("0 h, 0 m, 34 s", df.formatMillis(SECONDS.toMillis(33) + MILLISECONDS.toMillis(777)));

Of course you can create your own DurationFormatter without defaults by instantiating your own Builder

DurationFormatter df = new Builder().maximum(DAYS).minimum(NANOSECONDS).separator("|").valueSymbolSeparator("_")
	.symbol(HOURS, "hours").symbol(SECONDS, "seconds").symbol(TimeUnit.MICROSECONDS, "micros").build();
assertEquals("00|01_hours|02|03_seconds|000|000_micros|000", df.formatMillis(HOURS.toMillis(1) 
	+ MINUTES.toMillis(2) + SECONDS.toMillis(3)));

Integration

Since durationformatter is hosted on maven central Maven users can easily use the library by adding the dependency to their pom.xml:

<dependency>
	<groupId>com.github.pfichtner</groupId>
	<artifactId>durationformatter</artifactId>
	<version>XXX</version>
</dependency>

Non-maven users can copy the artifact(s) directly from maven central into their local workspace
http://central.maven.org/maven2/com/github/pfichtner/durationformatter/

License

Copyright 2012-2014 Peter Fichtner - Released under the Apache 2.0 license

Versions

Version
0.1.1 Apr 24, 2014
0.1.0 Apr 22, 2014
0.0.7 Aug 16, 2012
0.0.6 Aug 14, 2012