Package crypto.rules

Class CrySLRuleReader

java.lang.Object

crypto.rules.CrySLRuleReader

public class CrySLRuleReader
extends Object

Constructor Summary

Constructors

Constructor	Description
CrySLRuleReader()

Method Summary

Modifier and Type	Method	Description
static List<CrySLRule>	readFromDirectory(File directory)	Returns a List of CrySLRule objects read from a directory
static List<CrySLRule>	readFromDirectory(File directory, boolean recursive)	Returns a List of CrySLRule objects read from a directory.
static CrySLRule	readFromSourceFile(File file)	Returns a CrySLRule read from a single CrySL file.
static List<CrySLRule>	readFromZipFile(File file)	Returns a List of CrySLRule objects read from a Zip File.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrySLRuleReader

public CrySLRuleReader()

Method Detail

readFromSourceFile

public static CrySLRule readFromSourceFile(File file)
                                    throws CryptoAnalysisException

Returns a CrySLRule read from a single CrySL file.

Parameters:

file - the CrySL file

Returns:

the CrySLRule object

Throws:

CryptoAnalysisException - Throws when a file could not get processed to a CrySLRule

readFromDirectory

public static List<CrySLRule> readFromDirectory(File directory)
                                         throws CryptoAnalysisException

Returns a List of CrySLRule objects read from a directory

Parameters:

directory - the File with the directory where the rules are located

Returns:

the List with CrySLRule objects. If no rules are found it returns an empty list.

Throws:

CryptoAnalysisException - Throws when a file could not get processed to a CrySLRule

readFromDirectory

public static List<CrySLRule> readFromDirectory(File directory,
                                                boolean recursive)
                                         throws CryptoAnalysisException

Returns a List of CrySLRule objects read from a directory. In the case the directory contains further sub directories, they can also searched if the recursive argument is true.

Parameters:

directory - the File with the directory where the rules are located

recursive - true the subfolders will be searched too

Returns:

the List with CrySLRule objects. If no rules are found it returns an empty list.

Throws:

CryptoAnalysisException - Throws when a file could not get processed to a CrySLRule

readFromZipFile

public static List<CrySLRule> readFromZipFile(File file)
                                       throws CryptoAnalysisException

Returns a List of CrySLRule objects read from a Zip File.

Parameters:

file - Zip that contains the CrySL files

Returns:

the List with CrySLRule objects. If no rules are found it returns an empty list.

Throws:

CryptoAnalysisException - If the directory is not a zip file