com.lf.commons.dialog.options

Class FileTypeDef

java.lang.Object

com.lf.commons.dialog.options.FileTypeDef

public class FileTypeDef
extends java.lang.Object

Simple data holding class for file type definitions used by the FileTypeUnit.

Since:

1.6

Version:

$Revision: 1.11 $, $Date: 2016/01/01 15:43:01 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static int	APP_EDIT Mask value: application edit is allowed.
static int	APP_OPEN Mask value: application open is allowed.
boolean	appedit Set edit action to application, system otherwise.
int	appmask Mask value: application open/edit is allowed, use APP_OPEN, ...
boolean	appopen Set open action to application, system otherwise.
java.lang.String	id Each file type has a unique identifier.
static java.lang.String[]	IMAGE_MIME_TYPES The list of image MIME types supported by Commons.
java.lang.String	mime The MIME type like "image/png".
java.lang.String	pattern The pattern to recognize file names.
int	type The type SuffixFilter.PATTERN_SIMPLE_WITHOUT_CASE, ...

Constructor Summary

Constructors

Constructor and Description
FileTypeDef() Constructor method for i18n purposes only.
FileTypeDef(java.lang.String id, java.lang.String pattern, int type, java.lang.String mime, int appmask, boolean appopen, boolean appedit) Init functionality.

Method Summary

Methods

Modifier and Type	Method and Description
static FileTypeDef	createConfigZIPTypeDef(java.lang.String id, int appmask, boolean appopen, boolean appedit) Convenience creator.
static FileTypeDef	createImageBMPTypeDef(java.lang.String id, int appmask, boolean appopen, boolean appedit) Convenience creator.
static FileTypeDef	createImageGIFTypeDef(java.lang.String id, int appmask, boolean appopen, boolean appedit) Convenience creator.
static FileTypeDef	createImageJPEGTypeDef(java.lang.String id, int appmask, boolean appopen, boolean appedit) Convenience creator.
static FileTypeDef	createImagePNGTypeDef(java.lang.String id, int appmask, boolean appopen, boolean appedit) Convenience creator.
static FileTypeDef	createImageWBMPTypeDef(java.lang.String id, int appmask, boolean appopen, boolean appedit) Convenience creator.
static FileTypeDef	createLicensePGPTypeDef(java.lang.String id, int appmask, boolean appopen, boolean appedit) Convenience creator.
static FileTypeDef	createPGPKeyringTypeDef(java.lang.String id, int appmask, boolean appopen, boolean appedit) Convenience creator.
boolean	equals(FileTypeDef tocheck) Checks wether a given FileTypeDef instance is equal to this.
java.lang.String	toString() Overrides method java.lang.Object.toString.

Methods inherited from class java.lang.Object

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

Field Detail

APP_OPEN

public static final int APP_OPEN

Mask value: application open is allowed.

See Also:

Constant Field Values

APP_EDIT

public static final int APP_EDIT

Mask value: application edit is allowed.

See Also:

Constant Field Values

IMAGE_MIME_TYPES

public static final java.lang.String[] IMAGE_MIME_TYPES

The list of image MIME types supported by Commons.

id

public java.lang.String id

Each file type has a unique identifier.

pattern

public java.lang.String pattern

The pattern to recognize file names.

type

public int type

The type SuffixFilter.PATTERN_SIMPLE_WITHOUT_CASE, ...

mime

public java.lang.String mime

The MIME type like "image/png".

appmask

public int appmask

Mask value: application open/edit is allowed, use APP_OPEN, ...

appopen

public boolean appopen

Set open action to application, system otherwise.

appedit

public boolean appedit

Set edit action to application, system otherwise.

Constructor Detail

FileTypeDef

public FileTypeDef()
            throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

FileTypeDef

public FileTypeDef(java.lang.String id,
           java.lang.String pattern,
           int type,
           java.lang.String mime,
           int appmask,
           boolean appopen,
           boolean appedit)

Init functionality.

Parameters:

id - Each file type has a unique identifier (required)

pattern - The pattern to recognize file names (required)

type - The type SuffixFilter.PATTERN_SIMPLE_WITHOUT_CASE, ... (required)

mime - The MIME type like "image/png" (optional)

appmask - Mask value: application open/edit is allowed, use APP_OPEN, ...

appopen - Set open action to application, system otherwise

appedit - Set edit action to application, system otherwise

Throws:

java.lang.NullPointerException - If a parameter is null

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

Method Detail

toString

public java.lang.String toString()

Overrides method java.lang.Object.toString.

Overrides:

toString in class java.lang.Object

Returns:

The definition identifier

Since:

1.6

equals

public boolean equals(FileTypeDef tocheck)

Checks wether a given FileTypeDef instance is equal to this.

Parameters:

tocheck - Instance to be checked

Returns:

The FileTypeDef instance to check for equality

Since:

1.6

createConfigZIPTypeDef

public static FileTypeDef createConfigZIPTypeDef(java.lang.String id,
                                 int appmask,
                                 boolean appopen,
                                 boolean appedit)

Convenience creator.

Parameters:

id - The definition identifier

appmask - Mask value: application open/edit is allowed, use APP_OPEN, ... (required)

appopen - Application supports opening such files?

appedit - Application supports editing such files?

Returns:

The FileTypeDef instance

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

createLicensePGPTypeDef

public static FileTypeDef createLicensePGPTypeDef(java.lang.String id,
                                  int appmask,
                                  boolean appopen,
                                  boolean appedit)

Convenience creator.

Parameters:

id - The definition identifier

appmask - Mask value: application open/edit is allowed, use APP_OPEN, ... (required)

appopen - Application supports opening such files?

appedit - Application supports editing such files?

Returns:

The FileTypeDef instance

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

createImageBMPTypeDef

public static FileTypeDef createImageBMPTypeDef(java.lang.String id,
                                int appmask,
                                boolean appopen,
                                boolean appedit)

Convenience creator.

Parameters:

id - The definition identifier

appmask - Mask value: application open/edit is allowed, use APP_OPEN, ... (required)

appopen - Application supports opening such files?

appedit - Application supports editing such files?

Returns:

The FileTypeDef instance

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

createImageJPEGTypeDef

public static FileTypeDef createImageJPEGTypeDef(java.lang.String id,
                                 int appmask,
                                 boolean appopen,
                                 boolean appedit)

Convenience creator.

Parameters:

id - The definition identifier

appmask - Mask value: application open/edit is allowed, use APP_OPEN, ... (required)

appopen - Application supports opening such files?

appedit - Application supports editing such files?

Returns:

The FileTypeDef instance

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

createImageWBMPTypeDef

public static FileTypeDef createImageWBMPTypeDef(java.lang.String id,
                                 int appmask,
                                 boolean appopen,
                                 boolean appedit)

Convenience creator.

Parameters:

id - The definition identifier

appmask - Mask value: application open/edit is allowed, use APP_OPEN, ... (required)

appopen - Application supports opening such files?

appedit - Application supports editing such files?

Returns:

The FileTypeDef instance

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

createImagePNGTypeDef

public static FileTypeDef createImagePNGTypeDef(java.lang.String id,
                                int appmask,
                                boolean appopen,
                                boolean appedit)

Convenience creator.

Parameters:

id - The definition identifier

appmask - Mask value: application open/edit is allowed, use APP_OPEN, ... (required)

appopen - Application supports opening such files?

appedit - Application supports editing such files?

Returns:

The FileTypeDef instance

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

createImageGIFTypeDef

public static FileTypeDef createImageGIFTypeDef(java.lang.String id,
                                int appmask,
                                boolean appopen,
                                boolean appedit)

Convenience creator.

Parameters:

id - The definition identifier

appmask - Mask value: application open/edit is allowed, use APP_OPEN, ... (required)

appopen - Application supports opening such files?

appedit - Application supports editing such files?

Returns:

The FileTypeDef instance

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

createPGPKeyringTypeDef

public static FileTypeDef createPGPKeyringTypeDef(java.lang.String id,
                                  int appmask,
                                  boolean appopen,
                                  boolean appedit)

Convenience creator.

Parameters:

id - The definition identifier

appmask - Mask value: application open/edit is allowed, use APP_OPEN, ... (required)

appopen - Application supports opening such files?

appedit - Application supports editing such files?

Returns:

The FileTypeDef instance

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6