Java ResourceBundle.Control getTimeToLive() Method

---

---

Description

The java ResourceBundle.Control getTimeToLive(String baseName,Locale locale) method returns the time-to-live (TTL) value for resource bundles that are loaded under this ResourceBundle.Control.

Positive time-to-live values specify the number of milliseconds a bundle can remain in the cache without being validated against the source data from which it was constructed.

The value 0 indicates that a bundle must be validated each time it is retrieved from the cache. TTL_DONT_CACHE specifies that loaded resource bundles are not put in the cache. TTL_NO_EXPIRATION_CONTROL specifies that loaded resource bundles are put in the cache with no expiration control.

Declaration

Following is the declaration for java.util.Control.getTimeToLive() method

 public long getTimeToLive(String baseName, Locale locale) 

Parameters

• baseName − the base name of the resource bundle for which the expiration value is specified.

• locale − the locale of the resource bundle for which the expiration value is specified.

Return Value

This method returns the time (0 or a positive millisecond offset from the cached time) to get loaded bundles expired in the cache, TTL_NO_EXPIRATION_CONTROL to disable the expiration control, or TTL_DONT_CACHE to disable caching.

Exception

NullPointerException − if baseName or locale is null

Getting Time to Live of a Given Resource Bundle of US Locale Example

The following example shows the usage of Java ResourceBundle.Control getTimeToLive() method to get the time to live value for a given resource bundle. We've created a resource bundle control with FORMAT_DEFAULT using getControl() method. Then time to live of US Locale for the corresponding hello_en_US.properties file is printed using getTimeToLive() method.

 package com.tutorialspoint; import java.util.Locale; import java.util.ResourceBundle; import java.util.ResourceBundle.Control; public class ResourceBundleControlDemo { public static void main(String[] args) { // create a new ResourceBundle.Control with default format ResourceBundle.Control rbc = ResourceBundle.Control.getControl(Control.FORMAT_DEFAULT); // print time to live System.out.println("" + rbc.getTimeToLive("hello", Locale.US)); } } 

Output

Assuming we have a resource file hello_en_US.properties available in your CLASSPATH, with the following content. This file will be used as an input for our example program −

 hello = Hello World! 

Let us compile and run the above program, this will produce the following result −

 -2 

Getting Time to Live of a Given Resource Bundle of French Locale Example

The following example shows the usage of Java ResourceBundle.Control getTimeToLive() method to get the time to live value for a given resource bundle. We've created a resource bundle control with FORMAT_DEFAULT using getControl() method. Then time to live of French Locale for the corresponding hello_fr_FR.properties file is printed using getTimeToLive() method.

package com.tutorialspoint; import java.util.Locale; import java.util.ResourceBundle; import java.util.ResourceBundle.Control; public class ResourceBundleControlDemo { public static void main(String[] args) { // create a new ResourceBundle.Control with default format ResourceBundle.Control rbc = ResourceBundle.Control.getControl(Control.FORMAT_DEFAULT); // print time to live System.out.println("" + rbc.getTimeToLive("hello", Locale.FRANCE)); } }

Output

Assuming we have a resource file hello_fr_FR.properties available in your CLASSPATH, with the following content. This file will be used as an input for our example program −

 hello = Bonjour le monde! 

Let us compile and run the above program, this will produce the following result −

 -2 

Getting Time to Live of a Given Resource Bundle of German Locale Example

The following example shows the usage of Java ResourceBundle.Control getTimeToLive() method to get the time to live value for a given resource bundle. We've created a resource bundle control with FORMAT_DEFAULT using getControl() method. Then time to live of German Locale for the corresponding hello_de_DE.properties file is printed using getTimeToLive() method.

 package com.tutorialspoint; import java.util.Locale; import java.util.ResourceBundle; import java.util.ResourceBundle.Control; public class ResourceBundleControlDemo { public static void main(String[] args) { // create a new ResourceBundle.Control with default format ResourceBundle.Control rbc = ResourceBundle.Control.getControl(Control.FORMAT_DEFAULT); // print time to live System.out.println("" + rbc.getTimeToLive("hello", Locale.GERMANY)); } } 

Output

Assuming we have a resource file hello_de_DE.properties available in your CLASSPATH, with the following content. This file will be used as an input for our example program −

 hello = Hallo Welt! 

Let us compile and run the above program, this will produce the following result −

 -2