Packages

Documentation for the Axiell Utilities Project

Overview

The Axiell Utilities Project attempts to provide a small library of classes and object applicable to most Axiell developments. The library is not geared towards any one project and so should be useful for new projects as well as existing ones.

The library is based on a few simple principles, namely:

referential transparency. The principle that defines a call to a method with the same arguments will always return the same result and that the method does not have any side effects (e.g. updating global variables, etc).
functional programming support. If a method or class does have side effects then the method or class is marked as effectful. The library has been designed to not contain any effectful code.
minimal functionality. The library is designed to be small with support for a small number of common utilities. The main reason for the small size is to limit the number of dependencies drawn in by the package.

Package structure

The com.axiell.util package consists of a number of utilities, where each utility provides a single piece of functionality.

Notable utilities are:

Configure generic configuration reader allowing application settings defined as resources to be interrogated.
Error generic error handling class defining a locale independent error message along with details relating to the context of the error. The context may include an exception and other relevant values.
Formatter retrieves and formats a locale specific string from a specified resource bundle. The formatting is specified in a C printf style.
Implicits implements implicit methods and classes used to pimp methods onto existing classes (e.g. fold() method to Boolean class) and to provide implicit implementations for the JsonLocal and ShowLocal type classes.
JsonLocal type class used to output locale specific JSON structures. Implementations exist for Message and Error.
Message provides a locale independent mechanism for handling strings. The strings for a given locale are stored in resource bundles that are accessed when the message is to be displayed.
ShowLocal type class used to show locale specific strings. Allows Message and Error to be converted to a given language string.

Dependencies

The list of dependencies are:

Typesafe Config a generic configuration file reader. The library is used by the Configure class to access settings stored as resources within an application.

Definition Classes: root

package com

Definition Classes: root

package axiell

Definition Classes: com

package util

Axiell Utilities Project

A set of classes and traits that provide a simple mechanism for the internationalisation of strings and error handling. A mechanism is also supplied to read an application's configuration resource. All methods have been designed to be referentially transparent without the introduction of an effectful library (e.g. cats).

Imports

The utility classes/traits can be imported in the usual way, however it is necessary to include the Implicits object if the showLocal and jsonLocal type class methods are used, similarly for the read method on Configure.

Example:

import com.axiell.util.Implicits._

A shorthand way to gain access to all utility classes is to import:

import com.axiell.util._
import com.axiell.util.Implicits._

For more detail on project see the root package page.

Definition Classes: axiell

package instances

Contains implicit values used by type classes.

The implicit values are used by the ShowLocal, JsonLocal and ConfigureReader type classes to print out language dependent strings, language dependent JSON strings and read configuration values respectively.

Implicit values exist for the following classes:

ConfigureReader (read)
Error (showLocal, jsonLocal)
Int (showLocal, jsonLocal)
List (showLocal, jsonLocal)
Message (showLocal, jsonLocal)
java.time.OffsetDateTime (showLocal, jsonLocal)
java.lang.String (showLocal, jsonLocal)
java.lang.Throwable (showLocal, jsonLocal)

The method names appended in brackets are the extension methods added by the implicit values.

Definition Classes: util

package syntax

Contains implicit classes used to add extension methods.

The implicit classes are used to add the following extension methods:

showLocal displays a language dependent version of an object
jsonLocal generates a JSON string with language dependent strings
masonLocal generates a Mason Draft 2 compliant JSON string for Error
fold functionality for Boolean type

All traits found in the package are for the implementation of extension methods. The traits are mixed into the Implicits object so they can be easily imported into clients when required.

Definition Classes: util

Formatter

Companion object Formatter

final class Formatter extends AnyRef

Provides access to a set of language specific strings.

A code is used support language independent strings. The code is effectively a label used to identify a language specified string in a resource bundle loaded when the class was created. The string extracted from the bundle may contain printf() style formatting markers. In order to satisfy the formatting markers a variable number of arguments are passed along with the string code.

Source: Formatter.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Formatter
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
lazy val bundleName: String
Contains class name of the bundle loaded
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
def format(code: String, args: Any*): String
Extracts a strings from bundle and formats it with supplied arguments.
Extracts a strings from bundle and formats it with supplied arguments.
The code identifies a language specific string stored in the bundle. The string is extracted and then formatted using the variable list of arguments passed as parameters. The locale used to access the bundle is also used when formatting language specific values (e.g. numbers, etc).
Example:
```
class Messages_en extends java.util.ListResourceBundle {
  final override val getContents: Array[Array[AnyRef]] =
    Array(
      Array("BadValue", "The bad value is %s")
      ...
    )
}

val value = "abc123"
val fmt = Formatter(MessageBundle("Messages"), Locale.ENGLISH)
fmt.format("BadValue", value)
```
Output:
```
The bad value is abc123
```
code
identifying the string to be used
args
used to satisfy format markers in string
returns
formatted language specific string
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
val locale: Locale
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

Overview

Package structure

Dependencies

Imports

Formatter

Companion object Formatter

final class Formatter extends AnyRef

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Overview

Package structure

Dependencies

Imports

Formatter

Companion object Formatter

final class Formatter extends AnyRef

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Formatter