fr.sii.ogham.core.builder.resolution

Class ClassPathResolutionBuilder<P>

java.lang.Object

fr.sii.ogham.core.fluent.AbstractParent<P>

fr.sii.ogham.core.builder.resolution.AbstractSingleResolutionBuilder<ClassPathResolutionBuilder<P>,P>

fr.sii.ogham.core.builder.resolution.ClassPathResolutionBuilder<P>

Type Parameters:

P - the type of the parent builder (when calling AbstractParent.and() method)

All Implemented Interfaces:

Builder<ResourceResolver>, PrefixSuffixBuilder<ClassPathResolutionBuilder<P>>, Parent<P>

public class ClassPathResolutionBuilder<P>
extends AbstractSingleResolutionBuilder<ClassPathResolutionBuilder<P>,P>
implements PrefixSuffixBuilder<ClassPathResolutionBuilder<P>>

Configure resource resolver that loads files from classpath.

You can define the lookup (the prefix that indicates that classpath resolution must be used). For example:

 .classpath().lookup("classpath:");
 
 // path prefixed by classpath: matches 
 // then classpath resolver is used
 resourceResolver.getResource("classpath:foo/bar.html");
 // path is not prefixed (or using another prefix) doesn't match 
 // then classpath resolver is not used
 resourceResolver.getResource("foo/bar.html");
 

You can define a path prefix and suffix for finding resources:

 .classpath().lookup("classpath:").pathPrefix("foo/").pathSuffix(".html");
 
 resourceResolver.getResource("bar");
 

This will use the classpath resolver and the real path is foo/bar.html.

Author:

Aurélien Baudet

Field Summary

Fields inherited from class fr.sii.ogham.core.builder.resolution.AbstractSingleResolutionBuilder

buildContext, lookups, myself, pathPrefixValueBuilder, pathSuffixValueBuilder

Fields inherited from class fr.sii.ogham.core.fluent.AbstractParent

parent

Constructor Summary

Constructors

Constructor and Description
ClassPathResolutionBuilder(P parent, BuildContext buildContext) Initializes with the parent builder and the EnvironmentBuilder.

Method Summary

Modifier and Type	Method and Description
protected ResourceResolver	createResolver()
ConfigurationValueBuilder<ClassPathResolutionBuilder<P>,String>	pathPrefix() You can set the path prefix for resource resolution.
ClassPathResolutionBuilder<P>	pathPrefix(String prefix) You can set the path prefix for resource resolution.
ConfigurationValueBuilder<ClassPathResolutionBuilder<P>,String>	pathSuffix() You can set the path suffix for resource resolution.
ClassPathResolutionBuilder<P>	pathSuffix(String suffix) You can set the path suffix for resource resolution.

Methods inherited from class fr.sii.ogham.core.builder.resolution.AbstractSingleResolutionBuilder

build, getLookups, lookup, lookup

Methods inherited from class fr.sii.ogham.core.fluent.AbstractParent

and

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathResolutionBuilder

public ClassPathResolutionBuilder(P parent,
                                  BuildContext buildContext)

Initializes with the parent builder and the EnvironmentBuilder. The parent builder is used when calling the AbstractParent.and() method. The EnvironmentBuilder is used when calling AbstractSingleResolutionBuilder.build() method in order to evaluate property values.

Parameters:

parent - the parent builder

buildContext - for property resolution

Method Detail

createResolver

protected ResourceResolver createResolver()

Specified by:

createResolver in class AbstractSingleResolutionBuilder<ClassPathResolutionBuilder<P>,P>

pathPrefix

public ClassPathResolutionBuilder<P> pathPrefix(String prefix)

Description copied from interface: PrefixSuffixBuilder

You can set the path prefix for resource resolution. The aim is to define only the name of the resource (or a subset) and the system will find it for you. It avoids to explicitly write the whole path and let you change the resource resolution easily. For example:

• You have one template located into /foo/template/createAccount.html
• You have one template located into /foo/template/resetPassword.html

So you can set the prefix path to /foo/template/. You can now reference the templates using the file name:

• createAccount.html
• resetPassword.html

The value set using this method takes precedence over any property and default value configured using PrefixSuffixBuilder.pathPrefix().

 .pathPrefix("/foo/template/")
 .pathPrefix()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("/template/")
 

 .pathPrefix("/foo/template/")
 .pathPrefix()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("/template/")
 

In both cases, pathPrefix("/foo/template/") is used.

If this method is called several times, only the last value is used.

If null value is set, it is like not setting a value at all. The property/default value configuration is applied.

Specified by:

pathPrefix in interface PrefixSuffixBuilder<ClassPathResolutionBuilder<P>>

Parameters:

prefix - the path prefix

Returns:

this instance for fluent chaining

pathPrefix

public ConfigurationValueBuilder<ClassPathResolutionBuilder<P>,String> pathPrefix()

Description copied from interface: PrefixSuffixBuilder

You can set the path prefix for resource resolution. The aim is to define only the name of the resource (or a subset) and the system will find it for you. It avoids to explicitly write the whole path and let you change the resource resolution easily. For example:

• You have one template located into /foo/template/createAccount.html
• You have one template located into /foo/template/resetPassword.html

So you can set the prefix path to /foo/template/. You can now reference the templates using the file name:

• createAccount.html
• resetPassword.html

This method is mainly used by Configurers to register some property keys and/or a default value. The aim is to let developer be able to externalize its configuration (using system properties, configuration file or anything else). If the developer doesn't configure any value for the registered properties, the default value is used (if set).

 .pathPrefix()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("/template/")
 

Non-null value set using PrefixSuffixBuilder.pathPrefix(String) takes precedence over property values and default value.

 .pathPrefix("/foo/template/")
 .pathPrefix()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("/template/")
 

The value "/foo/template/" is used regardless of the value of the properties and default value.

See ConfigurationValueBuilder for more information.

Specified by:

pathPrefix in interface PrefixSuffixBuilder<ClassPathResolutionBuilder<P>>

Returns:

the builder to configure property keys/default value

pathSuffix

public ClassPathResolutionBuilder<P> pathSuffix(String suffix)

Description copied from interface: PrefixSuffixBuilder

You can set the path suffix for resource resolution. The aim is to define only the name of the resource (or a subset) and the system will find it for you. It avoids to explicitly write the whole path and let you change the resource resolution easily. For example:

• You have one template located into createAccount.html
• You have one template located into resetPassword.html

So you can set the suffix path to .html. You can now reference the templates using the file name:

• createAccount
• resetPassword

The value set using this method takes precedence over any property and default value configured using PrefixSuffixBuilder.pathSuffix().

 .pathSuffix(".html")
 .pathSuffix()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(".txt")
 

 .pathSuffix(".html")
 .pathSuffix()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(".txt")
 

In both cases, pathSuffix(".html") is used.

If this method is called several times, only the last value is used.

If null value is set, it is like not setting a value at all. The property/default value configuration is applied.

Specified by:

pathSuffix in interface PrefixSuffixBuilder<ClassPathResolutionBuilder<P>>

Parameters:

suffix - the path suffix

Returns:

this instance for fluent chaining

pathSuffix

public ConfigurationValueBuilder<ClassPathResolutionBuilder<P>,String> pathSuffix()

Description copied from interface: PrefixSuffixBuilder

You can set the path suffix for resource resolution. The aim is to define only the name of the resource (or a subset) and the system will find it for you. It avoids to explicitly write the whole path and let you change the resource resolution easily. For example:

• You have one template located into createAccount.html
• You have one template located into resetPassword.html

So you can set the suffix path to .html. You can now reference the templates using the file name:

• createAccount
• resetPassword

This method is mainly used by Configurers to register some property keys and/or a default value. The aim is to let developer be able to externalize its configuration (using system properties, configuration file or anything else). If the developer doesn't configure any value for the registered properties, the default value is used (if set).

 .pathSuffix()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(".txt")
 

Non-null value set using PrefixSuffixBuilder.pathSuffix(String) takes precedence over property values and default value.

 .pathSuffix(".html")
 .pathSuffix()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(".txt")
 

The value ".html" is used regardless of the value of the properties and default value.

See ConfigurationValueBuilder for more information.

Specified by:

pathSuffix in interface PrefixSuffixBuilder<ClassPathResolutionBuilder<P>>

Returns:

the builder to configure property keys/default value