us.daveread.basicquery.util

Enum FileFilterDefinition

java.lang.Object

java.lang.Enum<FileFilterDefinition>

us.daveread.basicquery.util.FileFilterDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FileFilterDefinition>

public enum FileFilterDefinition
extends java.lang.Enum<FileFilterDefinition>

The file filter pattern definitions used within the program

Author:

David Read

Enum Constant Summary

Enum Constants

Enum Constant and Description
QUERY_BQ BasicQuery Query Files
QUERY_SQL SQL Query Files
QUERY_TXT Text Files

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String[]	acceptedSuffixes The accepted file name suffixes for the file filter
private java.lang.String	description The description of the file filter
private boolean	isPreferredOption Is this the preferred option within its set of patterns

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	acceptedSuffixes() Get the accepted file name suffixes for the filter
java.lang.String	description() Get the description for the file filter
private java.lang.String	formatDescription(java.lang.String pDescription, java.lang.String[] suffixes) Format the description to include a list of suffixes
boolean	isPreferredOption() Determine whether this is the preferred (default) option for a group of file filters
static FileFilterDefinition	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FileFilterDefinition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

QUERY_BQ

public static final FileFilterDefinition QUERY_BQ

BasicQuery Query Files

QUERY_SQL

public static final FileFilterDefinition QUERY_SQL

SQL Query Files

QUERY_TXT

public static final FileFilterDefinition QUERY_TXT

Text Files

Field Detail

description

private final java.lang.String description

The description of the file filter

acceptedSuffixes

private final java.lang.String[] acceptedSuffixes

The accepted file name suffixes for the file filter

isPreferredOption

private boolean isPreferredOption

Is this the preferred option within its set of patterns

Method Detail

values

public static FileFilterDefinition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FileFilterDefinition c : FileFilterDefinition.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FileFilterDefinition valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

formatDescription

private java.lang.String formatDescription(java.lang.String pDescription,
                                 java.lang.String[] suffixes)

Format the description to include a list of suffixes

Parameters:

pDescription - The description

suffixes - The file name suffixes this filter accepts

Returns:

The description including suffixes

description

public java.lang.String description()

Get the description for the file filter

Returns:

The file filter description

acceptedSuffixes

public java.lang.String[] acceptedSuffixes()

Get the accepted file name suffixes for the filter

Returns:

The file name suffixes

isPreferredOption

public boolean isPreferredOption()

Determine whether this is the preferred (default) option for a group of file filters

Returns:

True if this filter is preferred