com.sun.faces.generate

Class PropertyManager

java.lang.Object

com.sun.faces.generate.PropertyManager

public class PropertyManager
extends Object

This class manages properties common to jsf-tools generators.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_OUTPUT_DIR The base directory in which all generated files are written to.
static String	COPYRIGHT A copyright to be included at the beginning of any generated file (may be null).
static String	JSP_VERSION_PROPERTY The minimum required version of JSP.
static String	RENDERKIT_ID The ID of the RenderKit for which the generation is being performed.
static String	TAGLIB_DESCRIPTION The description of the tag library (may be null).
static String	TAGLIB_DISPLAY_NAME The display-name of the generated tag library.
static String	TAGLIB_EXCLUDED_RENDERER_TYPES A comma separated list of renderer-types that must be excluded from taglib generation.
static String	TAGLIB_FILE_NAME The file name of the generated tag library descriptor.
static String	TAGLIB_INCLUDE The filename of a file to be included as part of the tag library generation process (may be null).
static String	TAGLIB_SHORT_NAME The short-name of the generated tag library.
static String	TAGLIB_URI The URI by which the tag library will be known by.
static String	TARGET_PACKAGE The target package for any generated code.

Method Summary

Modifier and Type	Method and Description
String	getProperty(String propertyName) Return the property specified by propertyName.
boolean	isExcludeRenderer(String rendererType)
static PropertyManager	newInstance(String propertyFile) Obtain a new PropertyManager instance backed by the properies contained in the specified file.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSP_VERSION_PROPERTY

public static final String JSP_VERSION_PROPERTY

The minimum required version of JSP.

See Also:

Constant Field Values

TAGLIB_SHORT_NAME

public static final String TAGLIB_SHORT_NAME

The short-name of the generated tag library.

See Also:

Constant Field Values

TAGLIB_DISPLAY_NAME

public static final String TAGLIB_DISPLAY_NAME

The display-name of the generated tag library.

See Also:

Constant Field Values

TAGLIB_URI

public static final String TAGLIB_URI

The URI by which the tag library will be known by.

See Also:

Constant Field Values

TAGLIB_DESCRIPTION

public static final String TAGLIB_DESCRIPTION

The description of the tag library (may be null).

See Also:

Constant Field Values

TAGLIB_FILE_NAME

public static final String TAGLIB_FILE_NAME

The file name of the generated tag library descriptor.

See Also:

Constant Field Values

TAGLIB_INCLUDE

public static final String TAGLIB_INCLUDE

The filename of a file to be included as part of the tag library generation process (may be null).

See Also:

Constant Field Values

TAGLIB_EXCLUDED_RENDERER_TYPES

public static final String TAGLIB_EXCLUDED_RENDERER_TYPES

A comma separated list of renderer-types that must be excluded from taglib generation.

See Also:

Constant Field Values

COPYRIGHT

public static final String COPYRIGHT

A copyright to be included at the beginning of any generated file (may be null).

See Also:

Constant Field Values

RENDERKIT_ID

public static final String RENDERKIT_ID

The ID of the RenderKit for which the generation is being performed.

See Also:

Constant Field Values

TARGET_PACKAGE

public static final String TARGET_PACKAGE

The target package for any generated code.

See Also:

Constant Field Values

BASE_OUTPUT_DIR

public static final String BASE_OUTPUT_DIR

The base directory in which all generated files are written to.

See Also:

Constant Field Values

Method Detail

newInstance

public static PropertyManager newInstance(String propertyFile)

Obtain a new PropertyManager instance backed by the properies contained in the specified file.

Parameters:

propertyFile - - property file

Returns:

a configured PropertyManager instance

getProperty

public String getProperty(String propertyName)

Return the property specified by propertyName.

Parameters:

propertyName - - the property name

Returns:

the value of the property or null if no value is defined

Throws:

IllegalArgumentException - of propertyName isn't a known property

IllegalStateException - if propertyName illegally has no value

isExcludeRenderer

public boolean isExcludeRenderer(String rendererType)

toString

public String toString()

Overrides:

toString in class Object