org.opencms.site.xmlsitemap

类 CmsPathIncludeExcludeSet

java.lang.Object

org.opencms.site.xmlsitemap.CmsPathIncludeExcludeSet

public class CmsPathIncludeExcludeSet
extends java.lang.Object

A helper class used for calculating which paths need to be included or excluded from the XML sitemap generation.

构造器概要

构造器

构造器和说明
CmsPathIncludeExcludeSet()

方法概要

方法

限定符和类型	方法和说明
void	addExclude(java.lang.String exclude) Adds an excluded path.
void	addInclude(java.lang.String include) Adds an included path.
java.util.Set<java.lang.String>	getIncludeRoots() Gets the root include paths, i.e. those include paths which don't have an ancestor path which is also an include path.
boolean	isExcluded(java.lang.String path) Checks if the given path is excluded by the include/exclude configuration.
protected java.lang.String	normalizePath(java.lang.String path) Converts a path to a normalized form.

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsPathIncludeExcludeSet

public CmsPathIncludeExcludeSet()

方法详细资料

addExclude

public void addExclude(java.lang.String exclude)

Adds an excluded path.

参数:

exclude - the path to add

addInclude

public void addInclude(java.lang.String include)

Adds an included path.

参数:

include - the path to add

getIncludeRoots

public java.util.Set<java.lang.String> getIncludeRoots()

Gets the root include paths, i.e. those include paths which don't have an ancestor path which is also an include path.

返回:

the list of root include paths

isExcluded

public boolean isExcluded(java.lang.String path)

Checks if the given path is excluded by the include/exclude configuration.

参数:

path - the path to check

返回:

true if the path is excluded

normalizePath

protected java.lang.String normalizePath(java.lang.String path)

Converts a path to a normalized form.

参数:

path - the path to normalize

返回:

the normalized path