org.apache.lucene.queryparser.flexible.messages.package.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100





   



For Native Language Support (NLS), system of software internationalization.

NLS message API

This utility API, adds support for NLS messages in the apache code.
It is currently used by the lucene "New Flexible Query PArser".


Features:
    

        Message reference in the code, using static Strings
        Message resource validation at class load time, for easier debugging
        Allows for message IDs to be re-factored using eclipse or other code re-factor tools
        Allows for reference count on messages, just like code
		Lazy loading of Message Strings        
        Normal loading Message Strings                  
    







Lazy loading of Message Strings

	public class MessagesTestBundle extends NLS {
	
	  private static final String BUNDLE_NAME = MessagesTestBundle.class.getName();
	
	  private MessagesTestBundle() {
	    // should never be instantiated
	  }
	
	  static {
	    // register all string ids with NLS class and initialize static string
	    // values
	    NLS.initializeMessages(BUNDLE_NAME, MessagesTestBundle.class);
	  }
	
	  // static string must match the strings in the property files.
	  public static String Q0001E_INVALID_SYNTAX;
	  public static String Q0004E_INVALID_SYNTAX_ESCAPE_UNICODE_TRUNCATION;
	
	  // this message is missing from the properties file
	  public static String Q0005E_MESSAGE_NOT_IN_BUNDLE;
	}

    // Create a message reference
    Message invalidSyntax = new MessageImpl(MessagesTestBundle.Q0001E_INVALID_SYNTAX, "XXX");
    
    // Do other stuff in the code...
    // when is time to display the message to the user or log the message on a file
    // the message is loaded from the correct bundle
    
    String message1 = invalidSyntax.getLocalizedMessage();
    String message2 = invalidSyntax.getLocalizedMessage(Locale.JAPANESE);








Normal loading of Message Strings

	String message1 = NLS.getLocalizedMessage(MessagesTestBundle.Q0004E_INVALID_SYNTAX_ESCAPE_UNICODE_TRUNCATION);
	String message2 = NLS.getLocalizedMessage(MessagesTestBundle.Q0004E_INVALID_SYNTAX_ESCAPE_UNICODE_TRUNCATION, Locale.JAPANESE);




The org.apache.lucene.messages.TestNLS junit contains several other examples.
The TestNLS java code is available from the Apache Lucene code repository.