# Locale.FilteringMode

public static final enum **Locale.FilteringMode** extends [Enum](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html)\<[Locale.FilteringMode](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.FilteringMode.html)\>  
This enum provides constants to select a filtering mode for locale
matching. Refer to [RFC 4647
Matching of Language Tags](http://tools.ietf.org/html/rfc4647) for details.

As an example, think of two Language Priority Lists each of which
includes only one language range and a set of following language tags:

```
    de (German)
    de-DE (German, Germany)
    de-Deva (German, in Devanagari script)
    de-Deva-DE (German, in Devanagari script, Germany)
    de-DE-1996 (German, Germany, orthography of 1996)
    de-Latn-DE (German, in Latin script, Germany)
    de-Latn-DE-1996 (German, in Latin script, Germany, orthography of 1996)
 
```
The filtering method will behave as follows:

| Filtering Mode | Language Priority List: `"de-DE"` | Language Priority List: `"de-*-DE"` |
|---|---|---|
| `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.FilteringMode.html#AUTOSELECT_FILTERING` | Performs *basic* filtering and returns `"de-DE"` and `"de-DE-1996"`. | Performs *extended* filtering and returns `"de-DE"`, `"de-Deva-DE"`, `"de-DE-1996"`, `"de-Latn-DE"`, and `"de-Latn-DE-1996"`. |
| `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.FilteringMode.html#EXTENDED_FILTERING` | Performs *extended* filtering and returns `"de-DE"`, `"de-Deva-DE"`, `"de-DE-1996"`, `"de-Latn-DE"`, and `"de-Latn-DE-1996"`. | Same as above. |
| `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.FilteringMode.html#IGNORE_EXTENDED_RANGES` | Performs *basic* filtering and returns `"de-DE"` and `"de-DE-1996"`. | Performs *basic* filtering and returns `null` because nothing matches. |
| `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.FilteringMode.html#MAP_EXTENDED_RANGES` | Same as above. | Performs *basic* filtering and returns `"de-DE"` and `"de-DE-1996"` because `"de-*-DE"` is mapped to `"de-DE"`. |
| `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.FilteringMode.html#REJECT_EXTENDED_RANGES` | Same as above. | Throws `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html` because `"de-*-DE"` is not a valid basic language range. |

<br />

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html#filter(java.util.List<java.util.Locale.LanguageRange>,%20java.util.Collection<java.util.Locale>,%20java.util.Locale.FilteringMode)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html#filterTags(java.util.List<java.util.Locale.LanguageRange>,%20java.util.Collection<java.lang.String>,%20java.util.Locale.FilteringMode)`

### Inherited Method Summary

From class [java.lang.Enum](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html)

|---|---|
| final [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html#clone())() Throws CloneNotSupportedException. |
| final int | [compareTo](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html#compareTo(E))([Locale.FilteringMode](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.FilteringMode.html) o) Compares this enum with the specified object for order. |
| final boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) other) Returns true if the specified object is equal to this enum constant. |
| final void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html#finalize())() enum classes cannot have finalize methods. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<[Locale.FilteringMode](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.FilteringMode.html)\> | [getDeclaringClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html#getDeclaringClass())() Returns the Class object corresponding to this enum constant's enum type. |
| final int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html#hashCode())() Returns a hash code for this enum constant. |
| final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [name](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html#name())() Returns the name of this enum constant, exactly as declared in its enum declaration. |
| final int | [ordinal](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html#ordinal())() Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero). |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html#toString())() Returns the name of this enum constant, as contained in the declaration. |
| static \<T extends [Enum](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html)\<T\>\> T | [valueOf](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html#valueOf(java.lang.Class<T>,%20java.lang.String))([Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<T\> enumType, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) name) Returns the enum constant of the specified enum type with the specified name. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.lang.Comparable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Comparable.html)

|---|---|
| abstract int | [compareTo](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Comparable.html#compareTo(T))([Locale.FilteringMode](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.FilteringMode.html) o) Compares this object with the specified object for order. |

## Enum Values

#### public static final Locale.FilteringMode
**AUTOSELECT_FILTERING**

Specifies automatic filtering mode based on the given Language
Priority List consisting of language ranges. If all of the ranges
are basic, basic filtering is selected. Otherwise, extended
filtering is selected.

#### public static final Locale.FilteringMode
**EXTENDED_FILTERING**

Specifies extended filtering.

#### public static final Locale.FilteringMode
**IGNORE_EXTENDED_RANGES**

Specifies basic filtering: Note that any extended language ranges
included in the given Language Priority List are ignored.

#### public static final Locale.FilteringMode
**MAP_EXTENDED_RANGES**

Specifies basic filtering: If any extended language ranges are
included in the given Language Priority List, they are mapped to the
basic language range. Specifically, a language range starting with a
subtag `"*"` is treated as a language range `"*"`. For
example, `"*-US"` is treated as `"*"`. If `"*"` is
not the first subtag, `"*"` and extra `"-"` are removed.
For example, `"ja-*-JP"` is mapped to `"ja-JP"`.

#### public static final Locale.FilteringMode
**REJECT_EXTENDED_RANGES**

Specifies basic filtering: If any extended language ranges are
included in the given Language Priority List, the list is rejected
and the filtering method throws `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html`.