final case class MessageBundle(name: String) extends Product with Serializable
Identifies the class name containing string resources.
A bundle is a set of classes containing string resources. Each
class in the set begins with the MessageBundle name and has
a locale appended to it identifying the language of the strings
it contains. A special case is the class name without any locale
appended. If a locale specific class cannot be located then the
class without the locale is appended.
A bundle extends the java.util.ListResoruceBundle class and overrides
the getContents method. The method returns an Array
where each element is an array containing two elements. The first
element is a code used to identify a string in a language independent
way and the second is a language dependent string.
Example:
class com.acme.Messages extends java.util.ListResourceBundle { final override val getContents: Array[Array[Object]] = Array( Array("BadValue", "The bad value is %s") ... ) } class com.acme.Messages_de extends java.util.ListResourceBundle { final override val getContents: Array[Array[Object]] = Array( Array("BadValue", "Der falsche Wert ist %s") ... ) }
The name of the class to supply to the MessageBundle to access the
above string resources is "com.acme.Messages". Hence the MessageBundle
is instantiated with:
MessageBundle("com.acme.Messages")Best practice would dictate that each resource bundle class is placed in a separate file so that only the strings for a given language are loaded when required.
- name
of the class containing the resource strings
- Source
- MessageBundle.scala
- Alphabetic
- By Inheritance
- MessageBundle
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MessageBundle(name: String)
- name
of the class containing the resource strings
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
- 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 finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
- 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()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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()
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:
Package structure
The
com.axiell.utilNotable utilities are:
Configuregeneric configuration reader allowing application settings defined as resources to be interrogated.Errorgeneric 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.Formatterretrieves and formats a locale specific string from a specified resource bundle. The formatting is specified in aCprintf style.Implicitsimplements implicit methods and classes used to pimp methods onto existing classes (e.g.fold()method toBooleanclass) and to provide implicit implementations for the JsonLocal and ShowLocal type classes.JsonLocaltype class used to output locale specific JSON structures. Implementations exist for Message and Error.Messageprovides 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.ShowLocaltype 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 Configa generic configuration file reader. The library is used by theConfigureclass to access settings stored as resources within an application.