org.znerd.logdoc.internal

Class LogController

java.lang.Object

org.znerd.logdoc.internal.LogController

public abstract class LogController
extends Object

Log controller. Can be used by the LogCentral class to set the locale on a specific Log class.

Each Log class should create exactly one LogController object, in a class initializer.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LogController() Constructs a new LogController object.

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	isLocaleSupported(String locale) Checks if the specified locale is supported.
abstract void	setLocale(String newLocale) Activates the specified locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogController

protected LogController()
                 throws UnsupportedLocaleException

Constructs a new LogController object.

Throws:

UnsupportedLocaleException - if this LogController does not support the current Locale.

Method Detail

isLocaleSupported

public abstract boolean isLocaleSupported(String locale)

Checks if the specified locale is supported.

Parameters:

locale - the locale, not null.

Returns:

true if the locale is supported, false if it is not.

setLocale

public abstract void setLocale(String newLocale)

Activates the specified locale.

This method should only be called with locales that are supported, according to isLocaleSupported(String). Otherwise the behaviour of this method is unspecified.

Parameters:

newLocale - the new locale, not null.