Package com.foreach.across.modules.web.resource.rules

Class AddWebResourceRule

java.lang.Object

com.foreach.across.modules.web.resource.rules.AddWebResourceRule

All Implemented Interfaces:

WebResourceRule

public class AddWebResourceRule
extends Object
implements WebResourceRule

A rule which specifies that a ViewElementBuilder must be added to a specific bucket of a WebResourceRegistry. Allows specifying key and order related properties of the resulting WebResourceRegistry.

Unlike directly calling WebResourceRegistry.addResourceToBucket(WebResourceReference, String) using this rule will not replace a previously registered resource with the same key, unless replaceIfPresent(boolean) has explicitly been set to true.

Since:

3.2.0

Author:

Marc Vanbrabant

See Also:

• ViewElementBuilder
• WebResourceReference
• WebResourceRegistry

Constructor Summary

Constructors

Constructor	Description
AddWebResourceRule()

Method Summary

Modifier and Type	Method	Description
AddWebResourceRule	after(@NonNull String after)
void	applyTo(WebResourceRegistry webResourceRegistry)
AddWebResourceRule	before(@NonNull String before)
String	getAfter()
String	getBefore()
String	getBucket()
String	getKey()
Integer	getOrder()
ViewElementBuilder	getViewElementBuilder()
boolean	isReplaceIfPresent()
AddWebResourceRule	of(@NonNull ViewElementBuilder viewElementBuilder)
AddWebResourceRule	order(int order)
AddWebResourceRule	replaceIfPresent(boolean replaceIfPresent)	Should the web resource be replaced if it is already present (based on the key).
AddWebResourceRule	toBucket(@NonNull String bucket)
AddWebResourceRule	withKey(String key)

Methods inherited from class java.lang.Object

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

Constructor Details

AddWebResourceRule

public AddWebResourceRule()

Method Details

withKey

public AddWebResourceRule withKey(String key)

toBucket

public AddWebResourceRule toBucket(@NonNull
 @NonNull String bucket)

before

public AddWebResourceRule before(@NonNull
 @NonNull String before)

after

public AddWebResourceRule after(@NonNull
 @NonNull String after)

order

public AddWebResourceRule order(int order)

replaceIfPresent

public AddWebResourceRule replaceIfPresent(boolean replaceIfPresent)

Should the web resource be replaced if it is already present (based on the key). Defaults to false.

Parameters:

replaceIfPresent - true if any previously registered resource with that key should be replaced

Returns:

rule

of

public AddWebResourceRule of(@NonNull
 @NonNull ViewElementBuilder viewElementBuilder)

applyTo

public void applyTo(WebResourceRegistry webResourceRegistry)

Specified by:

applyTo in interface WebResourceRule

getViewElementBuilder

public ViewElementBuilder getViewElementBuilder()

getAfter

public String getAfter()

getBefore

public String getBefore()

getOrder

public Integer getOrder()

getKey

public String getKey()

getBucket

public String getBucket()

isReplaceIfPresent

public boolean isReplaceIfPresent()