Packages

  • package root

    Documentation for the Axiell Utilities Project

    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

    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.

    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.

    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
  • BooleanSyntax
  • ErrorSyntax
  • JsonLocalSyntax
  • MasonLocalSyntax
  • ShowLocalSyntax

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.

Source
package.scala
Linear Supertypes
AnyRef, Any

Type Members

  1. trait BooleanSyntax extends AnyRef

    Adds extension methods to scala.Boolean

    Adds extension methods to scala.Boolean

    The implicit class used to contain the extension methods is wrapped in this trait so they can be mixed in with the Implicits object.

    The Syntax naming convention implies the trait adjusts the syntax of Boolean. In this case it adds extension methods.

  2. trait ErrorSyntax extends AnyRef

    Adds extension methods to Error

    Adds extension methods to Error

    The implicit class used to contain the extension methods is wrapped in this trait so they can be mixed in with the Implicits object.

    The Syntax naming convention implies the trait adjusts the syntax of Error. In this case it adds extension methods.

  3. trait JsonLocalSyntax extends AnyRef

    Contains implicit class to add jsonLocal extension method

    Contains implicit class to add jsonLocal extension method

    A trait is used to contain the jsonLocal extension method so it can be mixed into the Implicits object allowing the implicit class to be in scope when using the following import statement:

    import com.axiell.util.Implicits._
  4. trait MasonLocalSyntax extends AnyRef

    Adds extension methods to Error

    Adds extension methods to Error

    The implicit class used to contain the extension methods is wrapped in this trait so they can be mixed in with the Implicits object.

    The Syntax naming convention implies the trait adjusts the syntax of Error. In this case it adds extension methods.

    The extension methods provided allow error context information to be added to an Error that allows a Mason Draft 2 JSON error object to be generated. The following methods, along with their context label, are supported:

    • withId (@id)
    • withMessages (@messages)
    • withDetails (@details)
    • withHttpStatusCode (@httpStatusCode)
    • withControls (@controls)
    • withTime (@time)

    The mason extension method is also added to generate the Mason Draft 2 compliant JSON error object as a string.

  5. trait ShowLocalSyntax extends AnyRef

    Contains implicit class to add showLocal extension method

    Contains implicit class to add showLocal extension method

    A trait is used to contain the showLocal extension method so it can be mixed into the Implicits object allowing the implicit class to be in scope when using the following import statement:

    import com.axiell.util.Implicits._

Inherited from AnyRef

Inherited from Any

Ungrouped