Package hudson.plugins.locale

Class PluginImpl

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

hudson.plugins.locale.PluginImpl

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster

@Extension
@Symbol("locale")
public class PluginImpl
extends GlobalConfiguration

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	ALLOWED_LOCALES
static final String	USE_BROWSER_LOCALE

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
PluginImpl()

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject jsonObject)
ListBoxModel	doFillSystemLocaleItems()	Retrieves a ListBoxModel containing the available system locales.
static PluginImpl	get()
GlobalConfigurationCategory	getCategory()
protected XmlFile	getConfigFile()
String	getSystemLocale()
static void	init()
boolean	isAllowUserPreferences()
boolean	isIgnoreAcceptLanguage()
void	load()
static Locale	parse(String s)	Parses a string like "ja_JP" into a Locale object.
void	setAllowUserPreferences(boolean allowUserPreferences)	Sets whether the plugin should take user preferences into account.
void	setIgnoreAcceptLanguage(boolean ignoreAcceptLanguage)	Sets whether the plugin should take user preferences into account.
void	setSystemLocale(String systemLocale)

Methods inherited from class jenkins.model.GlobalConfiguration

all, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Field Details

USE_BROWSER_LOCALE

public static final String USE_BROWSER_LOCALE

See Also:

• Constant Field Values

ALLOWED_LOCALES

public static final Set<String> ALLOWED_LOCALES

Constructor Details

PluginImpl

public PluginImpl()

Method Details

get

public static PluginImpl get()

getConfigFile

protected XmlFile getConfigFile()

Overrides:

getConfigFile in class Descriptor<GlobalConfiguration>

init

@Initializer(after=EXTENSIONS_AUGMENTED)
public static void init()
                 throws Exception

Throws:

Exception

load

public void load()

Specified by:

load in interface Loadable

Overrides:

load in class Descriptor<GlobalConfiguration>

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest2 req,
 net.sf.json.JSONObject jsonObject)

Overrides:

configure in class GlobalConfiguration

isIgnoreAcceptLanguage

public boolean isIgnoreAcceptLanguage()

isAllowUserPreferences

public boolean isAllowUserPreferences()

getSystemLocale

public String getSystemLocale()

setSystemLocale

public void setSystemLocale(String systemLocale)

setIgnoreAcceptLanguage

public void setIgnoreAcceptLanguage(boolean ignoreAcceptLanguage)

Sets whether the plugin should take user preferences into account.

Parameters:

ignoreAcceptLanguage - If true, ignore browser preference and force this language to all users

Since:

1.3

setAllowUserPreferences

public void setAllowUserPreferences(boolean allowUserPreferences)

Sets whether the plugin should take user preferences into account.

Parameters:

allowUserPreferences - If true, ignore browser preference and use the language a user configured

parse

public static Locale parse(String s)

Parses a string like "ja_JP" into a Locale object.

Parameters:

s - the locale string using underscores as delimiters

Returns:

the Locale object

getCategory

@NonNull
public GlobalConfigurationCategory getCategory()

Overrides:

getCategory in class Descriptor<GlobalConfiguration>

doFillSystemLocaleItems

public ListBoxModel doFillSystemLocaleItems()

Retrieves a ListBoxModel containing the available system locales. This method populates a ListBoxModel with the available system locales, sorted lexicographically by their string representations. Each locale's display name and string representation are added as options to the model.

Returns:

A ListBoxModel containing the available system locales.