com.foreach.across.modules.webcms.domain.component

Class WebCmsContentMarkerService

java.lang.Object

com.foreach.across.modules.webcms.domain.component.WebCmsContentMarkerService

@Service
public class WebCmsContentMarkerService
extends Object

API for checking and parsing markers from a text. A marker is any fragment of the form @@fragment@@, all text between the @@ is considered the marker that should be replaced.

Using markers can be very convenient but take into account that performance wise the use of custom templates or custom rendering for component types is most likely better.

Since:

0.0.2

Author:

Arne Vandamme

See Also:

WebCmsComponentContentMarkerRenderer

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	MARKER_PATTERN

Constructor Summary

Constructors

Constructor and Description
WebCmsContentMarkerService()

Method Summary

Modifier and Type	Method and Description
boolean	containsMarkers(String text)
WebCmsContentMarker	parseMarker(String marker) Converts a string version of a marker into the WebCmsContentMarker.
String	replaceMarkers(String text, @NonNull Function<WebCmsContentMarker,String> markerValueFunction) Replace all markers in the text specified.
String	replaceMarkers(String text, Map<String,String> markerValues) Replace all markers in the text specified.
Collection<String>	retrieveMarkers(String text) Retrieve the unique markers in a text.
String	stripMarkers(String text) Simply strip all markers from the text.

Methods inherited from class java.lang.Object

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

Field Detail

MARKER_PATTERN

public static Pattern MARKER_PATTERN

Constructor Detail

WebCmsContentMarkerService

public WebCmsContentMarkerService()

Method Detail

parseMarker

public WebCmsContentMarker parseMarker(String marker)

Converts a string version of a marker into the WebCmsContentMarker.

Parameters:

marker - string

Returns:

marker instance

containsMarkers

public boolean containsMarkers(String text)

Parameters:

text - to check for markers

Returns:

true if the text contains any markers

retrieveMarkers

public Collection<String> retrieveMarkers(String text)

Retrieve the unique markers in a text.

Parameters:

text - to parse the markers from

Returns:

collection of markers found - can be empty

replaceMarkers

public String replaceMarkers(String text,
                             Map<String,String> markerValues)

Replace all markers in the text specified. Retrieves the value from the map passed as parameter.

Parameters:

text - to replace the markers in

markerValues - map of value for marker

Returns:

text with all markers replaced

stripMarkers

public String stripMarkers(String text)

Simply strip all markers from the text.

Parameters:

text - to remove all markers from

Returns:

text with markers removed

replaceMarkers

public String replaceMarkers(String text,
                             @NonNull
                             @NonNull Function<WebCmsContentMarker,String> markerValueFunction)

Replace all markers in the text specified. Uses the value function callback to determine the marker value. Null values will not be replaced!

Parameters:

text - to replace the markers in

markerValueFunction - to determine a marker value

Returns:

text with all markers replaced