Repository files navigation

API reference

NOTE This library is available to the public but it's mostly used internally at AVSystem. Therefore, API may frequently change in an incompatible way.

• commons-core - basic language utilities and generic features not associated with any particular library of framework:
  • GenCodec: format-agnostic, typeclass based serialization framework with automatic typeclassderivation for case classes and sealed hierarchies
    • built-in serialization formats include JSON (raw string),CBOR and BSON (incommons-mongo).
  • Typesafe RPC/proxy framework used in particular byUdash Framework forclient-server communication
  • Better enumeration support for Scala -ValueEnum,SealedEnumCompanion,NamedEnumCompanion,OrderedEnum
  • Java interoperability utilities -JavaInterop
  • Google Guava interoperability utilities (dependency on Guava is optional)
  • Various Scala language-level utilities
    • Implicit source information objects -SourceInfo
    • More concise aliases for Scala collection types -CollectionAliases
    • Universal extension methods -SharedExtensions
  • Lightweight alternatives for ScalaOption -Opt - guarantees nonulls,OptArg,NOpt,OptRef (implemented as value classes)
• commons-redis -Scala driver for Redis
• commons-akka - Akka utilities, primarilyAkkaRPCFrameworkwhich supports methods returning MonixObservables
• commons-macros contains implementations of macros used in other modules and reusable macro utilities:
  • MacroCommons trait with several convenience functions for implementing macros
  • TypeClassDerivation - implements infrastructure for automatic type class derivation
• commons-analyzer - static analyzer for Scala code, i.e. a compiler plugin that enforces various (mostly unrelated) rules and conventions on source code
• commons-jetty - Jetty server utilities
• commons-mongo - MongoDB utilities for Scala & Java MongoDB drivers, integration withGenCodec
• commons-hocon - Utilities for working withHOCON
  • HoconInput - anInput implementation forGenCodec that can read Lightbend Config (com.typesafe.config.Config)
  • An AST (HTree) and a lexer/parser for HOCON (HLexer,HParser)
• commons-spring - Spring framework utilities:
  • HoconBeanDefinitionReader - an utility that allows you to define Spring application context usingHOCON format

• Introduce your changes
• Write some unit tests
• Bump the version number inversion.sbt file
• Submit a pull request

• Publish the artifact locally
  • Usesbt publishLocal for projects managed by Ivy (e.g. SBT projects)
  • Orsbt publishM2 for projects managed by maven
• Update avsystem-commons dependency version in your project and refreshyour project dependencies