com.google.gwt.i18n.server

Interface KeyGenerator

All Known Implementing Classes:

FullyQualifiedMethodNameKeyGenerator, KeyGeneratorAdapter, MD5KeyGenerator, MethodNameKeyGenerator

public interface KeyGenerator

Interface for key generation algorithms used by LocalizableResource implementations. Implementations of this interface are executed at compile time, and therefore must not contain any JSNI code.

Method Summary

Methods

Modifier and Type	Method and Description
String	generateKey(Message msg) Generates a key for a given method with its default text and meaning.

Method Detail

generateKey

String generateKey(Message msg)

Generates a key for a given method with its default text and meaning.

NOTE: currently the MessageInterface and Message implementations passed to the key generator are incomplete as they are wrappers around the existing functionality. Only Message.getMessageInterface(), Message.getMethodName(), Message.getDefaultMessage(), Message.getDescription(), Message.getMeaning(), and Message.getMessageStyle() (and only MessageInterface.getClassName(), MessageInterface.getPackageName(), and MessageInterface.getQualifiedName() on the MessageInterface instance returned from Message.getMessageInterface()) may be relied upon until the i18n generator is updated.

Parameters:

msg - the message to generate a key for

Returns:

the lookup key as a string or null if the key cannot be computed (for example, if text is null but this generator requires it)