javafx.stage

Class FileChooser.ExtensionFilter

java.lang.Object

javafx.stage.FileChooser.ExtensionFilter

Enclosing class:

FileChooser

public static final class FileChooser.ExtensionFilter
extends java.lang.Object

Defines an extension filter, used for filtering which files can be chosen in a FileDialog based on the file name extensions.

Since:

JavaFX 2.0

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	description
private java.util.List<java.lang.String>	extensions

Constructor Summary

Constructors

Constructor and Description
ExtensionFilter(java.lang.String description, java.util.List<java.lang.String> extensions) Creates an ExtensionFilter with the specified description and the file name extensions.
ExtensionFilter(java.lang.String description, java.lang.String... extensions) Creates an ExtensionFilter with the specified description and the file name extensions.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Gets the description for this ExtensionFilter.
java.util.List<java.lang.String>	getExtensions() Gets the file name extensions for this ExtensionFilter.
private static void	validateArgs(java.lang.String description, java.lang.String[] extensions)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

description

private final java.lang.String description

extensions

private final java.util.List<java.lang.String> extensions

Constructor Detail

ExtensionFilter

public ExtensionFilter(java.lang.String description,
                       java.lang.String... extensions)

Creates an ExtensionFilter with the specified description and the file name extensions.

File name extension should be specified in the *.<extension> format.

Parameters:

description - the textual description for the filter

extensions - the accepted file name extensions

Throws:

java.lang.NullPointerException - if the description or the extensions are null

java.lang.IllegalArgumentException - if the description or the extensions are empty

ExtensionFilter

public ExtensionFilter(java.lang.String description,
                       java.util.List<java.lang.String> extensions)

Creates an ExtensionFilter with the specified description and the file name extensions.

File name extension should be specified in the *.<extension> format.

Parameters:

description - the textual description for the filter

extensions - the accepted file name extensions

Throws:

java.lang.NullPointerException - if the description or the extensions are null

java.lang.IllegalArgumentException - if the description or the extensions are empty

Method Detail

getDescription

public java.lang.String getDescription()

Gets the description for this ExtensionFilter.

Returns:

the description

getExtensions

public java.util.List<java.lang.String> getExtensions()

Gets the file name extensions for this ExtensionFilter.

The returned list is unmodifiable and will throw UnsupportedOperationException on each modification attempt.

Returns:

the file name extensions

validateArgs

private static void validateArgs(java.lang.String description,
                                 java.lang.String[] extensions)