{#========================================== Spincast Dictionary plugin ==========================================#} {% extends "../../layout.html" %} {% block sectionClasses %}plugins plugins-spincast-dictionary{% endblock %} {% block meta_title %}Plugins - Spincast Dictionary{% endblock %} {% block meta_description %}Spincast Dictionary plugin provides the default labels required by Spincast.{% endblock %} {% block scripts %} {% endblock %} {% block body %}
  1. Plugins
  2. Spincast Dictionary plugin

Spincast Dictionary plugin
Javadoc
default

Spincast Dictionary plugin

Overview

The Spincast Dictionary plugin provides an implementation of the ISpincastDictionary interface to provide labels required by Spincast.

The current implementation is very simple: the labels are simply hardcoded, in english.

Installation

If you use the spincast-default artifact, this plugin is already installed so you have nothing more to do!

If you start from scratch using the spincast-core artifact, you can use the plugin by adding this artifact to your project: 

<dependency>
    <groupId>org.spincast</groupId>
    <artifactId>spincast-plugins-dictionary</artifactId>
    <version>{{spincastCurrrentVersion}}</version>
</dependency>

You then install the plugin's Guice module, by passing it to the Guice.createInjector(...) method: 

Injector guice = Guice.createInjector(
        new SpincastCoreGuiceModule(args),
        new SpincastDictionaryPluginGuiceModule(IAppRequestContext.class, 
                                                IAppWebsocketContext.class)
        // other modules...
        );

... or by using the install(...) method from your custom Guice module: 

public class AppModule extends SpincastCoreGuiceModule {

    @Override
    protected void configure() {
        super.configure();
        install(new SpincastDictionaryPluginGuiceModule(getRequestContextType(), 
                                                        getWebsocketContextType()));
        // other modules...
    }
    
    // ...
}

The ISpincastDictionary interface

Methods :

  • String route_notFound_default_message()
    The message to display if the default Not Found route is used.
    @return the message to display
  • String exception_default_message()
    The message to display if the default Exception route is used.
    @return the message to display

{% endblock %}