com.lf.digester.docking

Class DigesterUtils

java.lang.Object

com.lf.digester.docking.DigesterUtils

public class DigesterUtils
extends java.lang.Object

Provides some useful functionality for use with the digester classes.

Since:

1.5

Version:

$Revision: 1.54 $, $Date: 2015/01/08 09:03:42 $

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
DigesterUtils() Constructor method for i18n purposes only.

Method Summary

Methods

Modifier and Type	Method and Description
static void	collectAllDigestFiles(java.util.Vector<java.io.File> collector, java.io.File directory, boolean recursion, com.lf.commons.task.BackgroundTask bgtask, java.util.Vector<com.lf.commons.io.SuffixFilter> filters) Collects all available files in a given local directory (File variant).
static void	collectAllDigestURLs(java.util.Vector<org.apache.commons.vfs2.FileObject> collector, org.apache.commons.vfs2.FileObject directory, boolean recursion, com.lf.commons.task.BackgroundTask bgtask, java.util.Vector<com.lf.commons.io.SuffixFilter> filters) Collects all available URLs in a given local directory (FileObject variant).
static void	collectAllFileEntries(java.util.Vector<java.io.File> collect, java.io.File directory, com.lf.commons.task.BackgroundTask bgtask) Collects all available entries in a given local directory (File variant).
static void	collectAllURLEntries(java.util.Vector<org.apache.commons.vfs2.FileObject> collect, org.apache.commons.vfs2.FileObject directory, com.lf.commons.task.BackgroundTask bgtask) Collects all available entries in a given network directory (FileObject variant).
static boolean	compareBytes(byte[] array1, byte[] array2) Compares two binary arrays.
static java.lang.Object	getAssociatedTarget(java.lang.Object sourcebase, java.lang.Object source, java.lang.Object targetbase) Assembles the target file/URL associated with the given source file/URL.
static boolean	isDigestFile(java.io.File file, java.util.Vector<com.lf.commons.io.SuffixFilter> filters) Checks the given file if the extension is one of the defined checksum file suffixes.
static boolean	isDigestURL(org.apache.commons.vfs2.FileObject url, java.util.Vector<com.lf.commons.io.SuffixFilter> filters) Checks the given URL if the extension is one of the defined checksum URL suffixes.
static boolean	isFilePerTarget(java.io.File digestfile, java.io.File target) Checks the given digest file if it was generated per target.
static boolean	isURLPerTarget(org.apache.commons.vfs2.FileObject digesturl, org.apache.commons.vfs2.FileObject target) Checks the given digest URL if it was generated per target.
static DigestResult	searchDigest(java.util.Vector<DigestResult> digests, org.apache.commons.vfs2.FileObject target, java.lang.String algorithm) Searches the container with calculation results for a specific digest.
static DigestResult	searchDigest(java.util.Vector<DigestResult> digests, java.io.File target, java.lang.String algorithm) Searches the container with calculation results for a specific digest.
static DigestResult[]	searchDigests(java.util.Vector<DigestResult> digests, org.apache.commons.vfs2.FileObject target, java.lang.String algorithm) Searches the container with calculation results for specific digests.
static DigestResult[]	searchDigests(java.util.Vector<DigestResult> digests, java.io.File target, java.lang.String algorithm) Searches the container with calculation results for specific digests.

Methods inherited from class java.lang.Object

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

Constructor Detail

DigesterUtils

public DigesterUtils()
              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

Method Detail

compareBytes

public static boolean compareBytes(byte[] array1,
                   byte[] array2)

Compares two binary arrays.

Parameters:

array1 - Binary array to be compared

array2 - Binary array to be compared

Returns:

Arrays match?

Since:

1.6

collectAllFileEntries

public static void collectAllFileEntries(java.util.Vector<java.io.File> collect,
                         java.io.File directory,
                         com.lf.commons.task.BackgroundTask bgtask)

Collects all available entries in a given local directory (File variant).

Collects entries in all sub-directories as well (recursion). The directory to search for entries will be included, too. Same code as IOUtils.collectAllEntries() but with runnable specific breakpoints where task interruption is checked.

Parameters:

collect - The Vector container to set entries

directory - The local dir to search for entries

bgtask - The background task (optional)

Since:

1.6

collectAllURLEntries

public static void collectAllURLEntries(java.util.Vector<org.apache.commons.vfs2.FileObject> collect,
                        org.apache.commons.vfs2.FileObject directory,
                        com.lf.commons.task.BackgroundTask bgtask)

Collects all available entries in a given network directory (FileObject variant).

Collects entries in all sub-directories as well (recursion). The directory to search for entries will be included, too. Same code as IOUtils.collectAllEntries() but with runnable specific breakpoints where task interruption is checked.

Parameters:

collect - The Vector container to set entries

directory - The local dir to search for entries

bgtask - The background task (optional)

Since:

1.6

isDigestFile

public static boolean isDigestFile(java.io.File file,
                   java.util.Vector<com.lf.commons.io.SuffixFilter> filters)

Checks the given file if the extension is one of the defined checksum file suffixes.

The allowed extensions have already been pre-processed at task creation time. The container only holds those extensions which are active, so users have the chance to only process MD5 checksums but no other files for example.

Parameters:

file - The file to be checked

filters - The extension filters

Returns:

Is it a checksum file?

Throws:

java.lang.NullPointerException - If file is invalid

Since:

1.6

isDigestURL

public static boolean isDigestURL(org.apache.commons.vfs2.FileObject url,
                  java.util.Vector<com.lf.commons.io.SuffixFilter> filters)

Checks the given URL if the extension is one of the defined checksum URL suffixes.

The allowed extensions have already been pre-processed at task creation time. The container only holds those extensions which are active, so users have the chance to only process MD5 checksums but no other files for example.

Parameters:

url - The URL to be checked

filters - The extension filters

Returns:

Is it a checksum URL?

Throws:

java.lang.NullPointerException - If URL is invalid

Since:

1.6

collectAllDigestFiles

public static void collectAllDigestFiles(java.util.Vector<java.io.File> collector,
                         java.io.File directory,
                         boolean recursion,
                         com.lf.commons.task.BackgroundTask bgtask,
                         java.util.Vector<com.lf.commons.io.SuffixFilter> filters)

Collects all available files in a given local directory (File variant).

Parameters:

collector - The container to add files to

directory - The local dir to search for files

recursion - Scan sub-directories, too?

bgtask - The background task (optional)

filters - The extension filters

Since:

1.6

isFilePerTarget

public static boolean isFilePerTarget(java.io.File digestfile,
                      java.io.File target)

Checks the given digest file if it was generated per target.

Parameters:

digestfile - The digest file

target - The target file

Returns:

Per target?

Since:

1.6

isURLPerTarget

public static boolean isURLPerTarget(org.apache.commons.vfs2.FileObject digesturl,
                     org.apache.commons.vfs2.FileObject target)

Checks the given digest URL if it was generated per target.

Parameters:

digesturl - The digest URL

target - The target URL

Returns:

Per target?

Since:

1.6

collectAllDigestURLs

public static void collectAllDigestURLs(java.util.Vector<org.apache.commons.vfs2.FileObject> collector,
                        org.apache.commons.vfs2.FileObject directory,
                        boolean recursion,
                        com.lf.commons.task.BackgroundTask bgtask,
                        java.util.Vector<com.lf.commons.io.SuffixFilter> filters)

Collects all available URLs in a given local directory (FileObject variant).

Parameters:

collector - The container to add URLs to

directory - The network folder to search for URLs

recursion - Scan sub-directories, too?

bgtask - The background task (optional)

filters - The extension filters

Since:

1.6

searchDigest

public static DigestResult searchDigest(java.util.Vector<DigestResult> digests,
                        java.io.File target,
                        java.lang.String algorithm)

Searches the container with calculation results for a specific digest.

Parameters:

digests - Container for result objects with message digests

target - Target for generation

algorithm - Algorithm to use

Returns:

The digest result or null if not available

Since:

1.6

searchDigests

public static DigestResult[] searchDigests(java.util.Vector<DigestResult> digests,
                           java.io.File target,
                           java.lang.String algorithm)

Searches the container with calculation results for specific digests.

Parameters:

digests - Container for result objects with message digests

target - Target for generation

algorithm - Algorithm to use

Returns:

The digest results, may be empty

Since:

1.6

searchDigest

public static DigestResult searchDigest(java.util.Vector<DigestResult> digests,
                        org.apache.commons.vfs2.FileObject target,
                        java.lang.String algorithm)

Searches the container with calculation results for a specific digest.

Parameters:

digests - Container for result objects with message digests

target - Target for generation

algorithm - Algorithm to use

Returns:

The digest result or null if not available

Since:

1.6

searchDigests

public static DigestResult[] searchDigests(java.util.Vector<DigestResult> digests,
                           org.apache.commons.vfs2.FileObject target,
                           java.lang.String algorithm)

Searches the container with calculation results for specific digests.

Parameters:

digests - Container for result objects with message digests

target - Target for generation

algorithm - Algorithm to use

Returns:

The digest results, may be empty

Since:

1.6

getAssociatedTarget

public static java.lang.Object getAssociatedTarget(java.lang.Object sourcebase,
                                   java.lang.Object source,
                                   java.lang.Object targetbase)

Assembles the target file/URL associated with the given source file/URL.

Parameters:

sourcebase - The source set base file/URL, same type as source

source - The source file/URL, same type as sourcebase

targetbase - The target set base file/URL

Returns:

The associated target, null otherwise

Since:

1.6