Java Locale getDisplayVariant() Method

---

---

Description

The Java Locale getDisplayVariant() method returns locale's variant code that is appropriate for display to the user. If possible, the name will be localized for the default DISPLAY locale. It returns the empty string if this locale doesn't specify a variant code.

Declaration

Following is the declaration for java.util.Locale.getDisplayVariant() method

public final String getDisplayVariant()

Parameters

NA

Return Value

This method returns the variant code of locale for the current default DISPLAY locale.

Exception

NA

Java Locale getDisplayVariant(Locale inLocale) Method

Description

The Java Locale getDisplayVariant(Locale inLocale) method returns locale's variant code that is appropriate for display to the user. If possible, the name will be localized for the given locale. It returns the empty string if this locale doesn't specify a variant code.

Declaration

Following is the declaration for java.util.Locale.getDisplayVariant() method

public String getDisplayVariant(Locale inLocale)

Parameters

NA

Return Value

This method returns the variant code for the current default DISPLAY locale.

Exception

NullPointerException − if inLocale is null

Getting Display Variant for US Locale Example

The following example shows the usage of Java Locale getDisplayVariant() methods. We're creating a locale of US and then Variant Code are retrieved without using any locale and printed.

package com.tutorialspoint;

import java.util.Locale;

public class LocaleDemo {
   public static void main(String[] args) {

      // create a new locale
      Locale locale = new Locale("en", "US", "WIN");

      // print this locale
      System.out.println("Locale:" + locale);

      // print the variant code of this locale
	  System.out.println("Variant Code:" + locale.getDisplayVariant());
   }
}

Output

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

Locale:en_US_WIN
Variant Code:WIN
Variant Code:WIN

Getting Display Variant for Germany Locale Example

The following example shows the usage of Java Locale getDisplayVariant(Locale) methods. We're creating a locale of US and then Variant Code are retrieved using German Locale and without using any locale and printed.

package com.tutorialspoint;

import java.util.Locale;

public class LocaleDemo {
   public static void main(String[] args) {

      // create a new locale
      Locale locale = new Locale("en", "US", "WIN");

      // print this locale
      System.out.println("Locale:" + locale);

      // print the variant code of this locale
	  System.out.println("Variant Code:" + locale.getDisplayVariant());
      System.out.println("Variant Code:" + locale.getDisplayVariant(Locale.GERMANY));
   }
}

Output

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

Locale:en_US_WIN
Variant Code:WIN
Variant Code:WIN