org.devacfr.maven.skins.reflow

Interface ISkinConfig

All Known Implementing Classes:

SkinConfigTool

public interface ISkinConfig

Interface of skin config.

Since:

2.1

Author:

devacfr

Method Summary

Modifier and Type	Method and Description
<T> T	eval(String vtl, Class<T> requiredClass) Evaluate a velocity expression in the current context.
org.codehaus.plexus.util.xml.Xpp3Dom	get(String property) Default accessor for config properties.
<T> T	getAttributeValue(String property, String attribute, Class<T> targetType, T defaultValue) Gets the attribute value of the given attribute of property.
<T> T	getAttributeValue(org.codehaus.plexus.util.xml.Xpp3Dom element, String attribute, Class<T> targetType, T defaultValue) Get the value contained in specific attribute of element parameter.
Context<?>	getContext()
<T> T	getContextValue(String key, Class<T> type) Gets the associated value to key stored in Velocity context.
String	getFileId()
org.codehaus.plexus.util.xml.Xpp3Dom	getGlobalProperties()
String	getNamespace()
org.codehaus.plexus.util.xml.Xpp3Dom	getPageProperties()
org.apache.maven.project.MavenProject	getProject()
Object	getProjectId()
<T> T	getPropertyValue(String property, Class<T> targetType, T defaultValue) Gets the text value of the given property.
String	getResourcePath()
org.apache.maven.doxia.site.SiteModel	getSiteModel()
<T> T	getToolbox(String toolName, Class<T> toolType) Gets the associated tool to name stored in toolbox of Velocity context.
boolean	isActiveLink(String href) Gets the indicating if the link is active.
boolean	not(String property) A convenience method to check if the value of the property is "false".
String	relativeLink(String href)
void	setContextValue(String key, Object value) Sets the value in Velocity context associated to key.

Method Detail

not

boolean not(String property)

A convenience method to check if the value of the property is "false". Useful for properties that are enabled by default - checks if the property is set to "false" explicitly.

Parameters:

property - the property of interest

Returns:

true if the configuration value is set either in page or globally, and is equal to "false". Note that this will return false if property is not set at all.

Since:

1.0

See Also:

get(String)

getContextValue

<T> T getContextValue(@Nonnull
                      String key,
                      @Nonnull
                      Class<T> type)

Gets the associated value to key stored in Velocity context.

Type Parameters:

T - the type of expected value.

Parameters:

key - the key name of associated value in Velocity context.

type - the the type of expected value.

Returns:

Returns the associated value to key stored in Velocity context.

Since:

2.1

setContextValue

void setContextValue(@Nonnull
                     String key,
                     Object value)

Sets the value in Velocity context associated to key.

Parameters:

key - the key name of associated value in Velocity context.

value - the new value

Since:

2.1

getToolbox

@Nullable
<T> T getToolbox(@Nonnull
                           String toolName,
                           @Nonnull
                           Class<T> toolType)

Gets the associated tool to name stored in toolbox of Velocity context.

Type Parameters:

T - the type of expected tool.

Parameters:

toolName - the name of tool associated in Velocity context.

toolType - the expected class of tool.

Returns:

Returns the associated tool to name stored in toolbox of Velocity context.

Since:

2.1

getGlobalProperties

@Nonnull
org.codehaus.plexus.util.xml.Xpp3Dom getGlobalProperties()

Returns:

Returns the root level Xpp3Dom.

getPageProperties

@Nonnull
org.codehaus.plexus.util.xml.Xpp3Dom getPageProperties()

Returns:

Returns the page level Xpp3Dom.

getNamespace

@Nonnull
String getNamespace()

Returns:

Returns a String representing the namespace.

getFileId

@Nullable
String getFileId()

Returns:

Returns the String representing the fileId.

getContext

@Nonnull
Context<?> getContext()

Returns:

the context

getProjectId

@Nullable
Object getProjectId()

Returns:

Returns the String representing the projectId.

getProject

@Nonnull
org.apache.maven.project.MavenProject getProject()

Returns:

the project

getSiteModel

@Nonnull
org.apache.maven.doxia.site.SiteModel getSiteModel()

Returns:

the SiteModel

get

@Nullable
org.codehaus.plexus.util.xml.Xpp3Dom get(@Nonnull
                                                   String property)

Default accessor for config properties. Instead of using $config.get("myproperty"), one can utilise Velocity fallback onto the default getter and use $config.myproperty.

Parameters:

property - the property of interest

Returns:

configuration node if found in the following sequence:

1. In page configuration
2. In global configuration
3. null otherwise

Since:

1.0

getPropertyValue

@Nullable
<T> T getPropertyValue(@Nonnull
                                 String property,
                                 @Nonnull
                                 Class<T> targetType,
                                 @Nullable
                                 T defaultValue)

Gets the text value of the given property.

Type Parameters:

T - the type of returned object.

Parameters:

property - the property to use

targetType - the returned target type use to convert value.

defaultValue - the default value used if property doesn't exist.

Returns:

Returns a converted value of the given property.

Since:

2.0

getAttributeValue

@Nullable
<T> T getAttributeValue(@Nonnull
                                  String property,
                                  @Nonnull
                                  String attribute,
                                  @Nonnull
                                  Class<T> targetType,
                                  @Nullable
                                  T defaultValue)

Gets the attribute value of the given attribute of property.

Type Parameters:

T - the type of returned object.

Parameters:

property - the property to use

attribute - the attribute to use.

targetType - the returned target type use to convert value.

defaultValue - the default value used if property doesn't exist.

Returns:

Returns a converted value of the given property.

Since:

2.0

getAttributeValue

@Nullable
<T> T getAttributeValue(@Nonnull
                                  org.codehaus.plexus.util.xml.Xpp3Dom element,
                                  @Nonnull
                                  String attribute,
                                  @Nonnull
                                  Class<T> targetType,
                                  T defaultValue)

Get the value contained in specific attribute of element parameter.

Type Parameters:

T - the type of returned value.

Parameters:

element - the xml element.

attribute - the attribute name.

targetType - the class of converted returned value.

defaultValue - the value to return if attribute is empty or null.

Returns:

Returns the converted value of specific attribute of element parameter if exists, otherwise returns the default value.

relativeLink

@Nullable
String relativeLink(String href)

Parameters:

href - link to relative.

Returns:

Returns Relativizes the link.

isActiveLink

boolean isActiveLink(@Nullable
                     String href)

Gets the indicating if the link is active.

Parameters:

href - the link to check.

Returns:

Returns true the link is active, otherwise false.

eval

@Nullable
<T> T eval(@Nullable
                     String vtl,
                     @Nonnull
                     Class<T> requiredClass)

Evaluate a velocity expression in the current context.

Type Parameters:

T - Tthe type of expected returned value.

Parameters:

vtl - The velocity expression to evaluate

requiredClass - the class of returned value.

Returns:

Returns the value returned by the evaluated velocity expression.

getResourcePath

@Nonnull
String getResourcePath()

Returns:

Returns a String representing the relative path to root site.