Package org.opencms.xml

Class CmsLinkFinisher

java.lang.Object

org.opencms.xml.CmsLinkFinisher

public class CmsLinkFinisher
extends Object

Does final postprocessing on a link by cutting off specific path suffixes (e.g. index.html).

Constructor Summary

Constructors

Constructor	Description
CmsLinkFinisher(boolean enabled, Collection<String> defaultFileNames, String exclude)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	transformLink(String link, boolean full)	Transforms the link into a finished format.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsLinkFinisher

public CmsLinkFinisher(boolean enabled,
 Collection<String> defaultFileNames,
 String exclude)

Creates a new instance.

Parameters:

enabled - true if it should be enabled

defaultFileNames - the default file names to remove

exclude - regex to prevent certain links from being finished if they match

Method Details

transformLink

public String transformLink(String link,
 boolean full)

Transforms the link into a finished format.

Parameters:

link - the link

full - in full mode, remove all configured suffixes, otherwise just remove trailing slashes

Returns: