public class

LocalePropertyProviderGenerator

extends Object
implements PropertyProviderGenerator
java.lang.Object
   ↳ com.google.gwt.i18n.linker.LocalePropertyProviderGenerator

Class Overview

Generates a property provider implementation for the "locale" property.

Summary

Constants
String LOCALE_COOKIE
String LOCALE_QUERYPARAM
String LOCALE_SEARCHORDER
String LOCALE_USEMETA
String LOCALE_USERAGENT
Fields
protected static final Pattern COOKIE_PATTERN
protected static final Pattern QUERYPARAM_PATTERN
Public Constructors
LocalePropertyProviderGenerator()
Public Methods
String generate(TreeLogger logger, SortedSet<String> possibleValues, String fallback, SortedSet<ConfigurationProperty> configProperties)
Protected Methods
void generateCookieLookup(TreeLogger logger, SourceWriter body, String cookieName)
Generate JS code that looks up the locale value from a cookie.
void generateInheritanceLookup(TreeLogger logger, SourceWriter body)
Generate JS code that takes the value of the "locale" variable and finds parent locales until the value is a supported locale or the default locale.
void generateMetaLookup(TreeLogger logger, SourceWriter body)
Generate JS code to fetch the locale from a meta property.
void generateQueryParamLookup(TreeLogger logger, SourceWriter body, String queryParam)
Generate JS code to get the locale from a query parameter.
void generateUserAgentLookup(TreeLogger logger, SourceWriter body)
Generate JS code to fetch the locale from the user agent's compile-time locale.
static boolean isTrue(String value)
Return true when the supplied value represents a true/yes/on value.
boolean validateCookieName(String cookieName)
Validate that a name is a valid cookie name.
boolean validateQueryParam(String queryParam)
Validate that a value is a valid query parameter name.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.google.gwt.core.ext.linker.PropertyProviderGenerator

Constants

public static final String LOCALE_COOKIE

Constant Value: "locale.cookie"

public static final String LOCALE_QUERYPARAM

Constant Value: "locale.queryparam"

public static final String LOCALE_SEARCHORDER

Constant Value: "locale.searchorder"

public static final String LOCALE_USEMETA

Constant Value: "locale.usemeta"

public static final String LOCALE_USERAGENT

Constant Value: "locale.useragent"

Fields

protected static final Pattern COOKIE_PATTERN

protected static final Pattern QUERYPARAM_PATTERN

Public Constructors

public LocalePropertyProviderGenerator ()

Public Methods

public String generate (TreeLogger logger, SortedSet<String> possibleValues, String fallback, SortedSet<ConfigurationProperty> configProperties)

Throws
UnableToCompleteException

Protected Methods

protected void generateCookieLookup (TreeLogger logger, SourceWriter body, String cookieName)

Generate JS code that looks up the locale value from a cookie.

Parameters
logger logger to use
Throws
UnableToCompleteException

protected void generateInheritanceLookup (TreeLogger logger, SourceWriter body)

Generate JS code that takes the value of the "locale" variable and finds parent locales until the value is a supported locale or the default locale.

Parameters
logger logger to use
Throws
UnableToCompleteException

protected void generateMetaLookup (TreeLogger logger, SourceWriter body)

Generate JS code to fetch the locale from a meta property.

Parameters
logger logger to use
Throws
UnableToCompleteException

protected void generateQueryParamLookup (TreeLogger logger, SourceWriter body, String queryParam)

Generate JS code to get the locale from a query parameter.

Parameters
logger logger to use
body where to append JS output
queryParam the query parameter to use
Throws
UnableToCompleteException

protected void generateUserAgentLookup (TreeLogger logger, SourceWriter body)

Generate JS code to fetch the locale from the user agent's compile-time locale.

Parameters
logger logger to use
Throws
UnableToCompleteException

protected static boolean isTrue (String value)

Return true when the supplied value represents a true/yes/on value.

Returns
  • true if the string represents true/yes/on

protected boolean validateCookieName (String cookieName)

Validate that a name is a valid cookie name.

Returns
  • true if cookieName is an acceptable cookie name

protected boolean validateQueryParam (String queryParam)

Validate that a value is a valid query parameter name.

Returns
  • true if queryParam is a valid query parameter name.