org.jorion.jdepend
Class PropertyConfigurator

java.lang.Object
  org.jorion.jdepend.PropertyConfigurator

public class PropertyConfigurator
extends java.lang.Object

The PropertyConfigurator class contains configuration information contained in the jdepend.properties file, if such a file exists either in the user's home directory or somewhere in the classpath.

Author:

Mike Clark, Clarkware Consulting, Inc.

Field Summary

static java.lang.String

DEFAULT_PROPERTY_FILE Default property file.

Constructor Summary

PropertyConfigurator()
Constructs a PropertyConfigurator instance containing the properties specified in the file jdepend.properties, if it exists.

PropertyConfigurator(java.io.File f)
Constructs a PropertyConfigurator instance with the specified property file.

PropertyConfigurator(java.util.Properties p)
Constructs a PropertyConfigurator instance with the specified property set.

Method Summary

boolean	getAnalyzeInnerClasses()
java.util.Collection<JavaPackage>	getConfiguredPackages()
static java.io.File	getDefaultPropertyFile()
java.util.Collection<java.lang.String>	getFilteredPackages()
static java.util.Properties	loadProperties(java.io.File file)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROPERTY_FILE

public static final java.lang.String DEFAULT_PROPERTY_FILE

Default property file.

See Also:

Constant Field Values

Constructor Detail

PropertyConfigurator

public PropertyConfigurator()

Constructs a PropertyConfigurator instance containing the properties specified in the file jdepend.properties, if it exists.

PropertyConfigurator

public PropertyConfigurator(java.util.Properties p)

Constructs a PropertyConfigurator instance with the specified property set.

Parameters:

p - Property set.

PropertyConfigurator

public PropertyConfigurator(java.io.File f)

Constructs a PropertyConfigurator instance with the specified property file.

Parameters:

f - Property file.

Method Detail

getFilteredPackages

public java.util.Collection<java.lang.String> getFilteredPackages()

Returns:

The list of filtered packages.

getConfiguredPackages

public java.util.Collection<JavaPackage> getConfiguredPackages()

Returns:

The list of configured packages.

getAnalyzeInnerClasses

public boolean getAnalyzeInnerClasses()

Returns:

True if the inner classes must be analyzed.

getDefaultPropertyFile

public static java.io.File getDefaultPropertyFile()

Returns:

The default property file.

loadProperties

public static java.util.Properties loadProperties(java.io.File file)

Parameters:

file - The file to load.

Returns:

A Properties object.