org.richfaces.cdk

Interface NamingConventions

All Known Implementing Classes:

RichFacesConventions

public interface NamingConventions

That interface defines methods that calculates names according to CDK naming conventions

Author:

asmirnov@exadel.com

Method Summary

Methods

Modifier and Type	Method and Description
ClassName	inferBehaviorClass(FacesId id) Infer name for generated behavior class by type
FacesId	inferBehaviorType(ClassName targetClass) Infer behavior type by class name
FacesId	inferComponentType(ClassName componentClass) Calculates component type from class name.
ClassName	inferRendererClass(FacesId id) Infer Java class name by renderer type.
FacesId	inferRendererFamily(FacesId type) Infer renderer family by renderer type
FacesId	inferRendererType(ClassName targetClass) Determine renderer type by Java class
FacesId	inferRendererType(FacesId id) Infer renderer type by component type or family.
FacesId	inferRendererTypeByTemplatePath(String templateName) Infer renderer type from template file path
ClassName	inferTagHandlerClass(FacesId componentType, String markup)
String	inferTaglibName(String uri) Infer short taglib name from URI
String	inferTaglibUri(ComponentLibrary library) Determine default taglib uri from library model.
String	inferTagName(FacesId componentType) Infer VDL tag name by component type
ClassName	inferUIComponentClass(FacesId componentType) Calculates concrete component class from explicit value or type.
FacesId	inferUIComponentFamily(FacesId componentType) Infer component family by component type

Method Detail

inferComponentType

FacesId inferComponentType(ClassName componentClass)
                           throws InvalidNameException

Calculates component type from class name.

• <prefix>.component.Abstract<Name> =><prefix>.<Name>
• <prefix>.component.<Name>Base => <prefix>.<Name>
• <prefix>.component.UI<Name> => <prefix>.<Name>

Parameters:

componentClass -

Returns:

JSF component type.

Throws:

InvalidNameException - if className does not match naming conventions.

inferUIComponentClass

ClassName inferUIComponentClass(FacesId componentType)
                                throws InvalidNameException

Calculates concrete component class from explicit value or type.

• Calculate name from type as <prefix>.<Name> => <prefix>.component.UI<Name> .

Parameters:

componentType - JSF component type.

Returns:

Descriptor of generated UIComponent class.

Throws:

InvalidNameException - if component type does not follow naming conventions.

inferUIComponentFamily

FacesId inferUIComponentFamily(FacesId componentType)
                               throws InvalidNameException

Infer component family by component type

Parameters:

componentType -

Returns:

Throws:

InvalidNameException

inferTagHandlerClass

ClassName inferTagHandlerClass(FacesId componentType,
                             String markup)
                               throws InvalidNameException

Parameters:

componentType -

markup -

Returns:

Throws:

InvalidNameException

inferTagName

String inferTagName(FacesId componentType)
                    throws InvalidNameException

Infer VDL tag name by component type

Parameters:

componentType -

Returns:

Throws:

InvalidNameException

inferRendererType

FacesId inferRendererType(ClassName targetClass)

Determine renderer type by Java class

Parameters:

targetClass -

Returns:

inferRendererFamily

FacesId inferRendererFamily(FacesId type)

Infer renderer family by renderer type

Parameters:

type -

Returns:

inferRendererTypeByTemplatePath

FacesId inferRendererTypeByTemplatePath(String templateName)

Infer renderer type from template file path

Parameters:

templateName -

Returns:

inferRendererClass

ClassName inferRendererClass(FacesId id)

Infer Java class name by renderer type.

Parameters:

id -

Returns:

inferBehaviorType

FacesId inferBehaviorType(ClassName targetClass)

Infer behavior type by class name

Parameters:

targetClass -

Returns:

inferBehaviorClass

ClassName inferBehaviorClass(FacesId id)

Infer name for generated behavior class by type

Parameters:

id -

Returns:

inferTaglibUri

String inferTaglibUri(ComponentLibrary library)

Determine default taglib uri from library model.

Parameters:

library -

Returns:

inferTaglibName

String inferTaglibName(String uri)

Infer short taglib name from URI

Parameters:

uri -

Returns:

inferRendererType

FacesId inferRendererType(FacesId id)

Infer renderer type by component type or family.

Parameters:

id -

Returns: