Package org.apache.jackrabbit.vault.fs.api

Class RegexpPathMapping

java.lang.Object

org.apache.jackrabbit.vault.fs.api.RegexpPathMapping

All Implemented Interfaces:

PathMapping

public final class RegexpPathMapping
extends Object
implements PathMapping

Implements a path mapping that supports regular expressions, i.e. /etc/(.*)=/dummy/$1/custom

Since:

3.1.42

Field Summary

Fields inherited from interface org.apache.jackrabbit.vault.fs.api.PathMapping

IDENTITY

Constructor Summary

Constructors

Constructor	Description
RegexpPathMapping()

Method Summary

Modifier and Type	Method	Description
<K,V> @NotNull RegexpPathMapping	addAllMappings(@NotNull Map<K,V> pathsMappingMap)	Allows importing mappings specified in data structure such as Map or Properties.
@NotNull RegexpPathMapping	addMapping(@NotNull String fromPattern, @NotNull String toPattern)	Add a new mapping based on regular expression.
@NotNull String	map(@NotNull String path)	Maps the given path to a new location.
@NotNull String	map(@NotNull String path, boolean reverse)	Maps the given path to a new location.
@NotNull RegexpPathMapping	merge(@Nullable RegexpPathMapping base)	Merges the regexp mapping from the given base mapping.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexpPathMapping

public RegexpPathMapping()

Method Detail

addAllMappings

@NotNull
public <K,V> @NotNull RegexpPathMapping addAllMappings(@NotNull
                                                             @NotNull Map<K,V> pathsMappingMap)

Allows importing mappings specified in data structure such as Map or Properties. All null entries (both keys and values) are ignored.

Type Parameters:

V - Value type

K - KEey type

Parameters:

pathsMappingMap - the data structure containing the mapping

Returns:

this

addMapping

@NotNull
public @NotNull RegexpPathMapping addMapping(@NotNull
                                             @NotNull String fromPattern,
                                             @NotNull
                                             @NotNull String toPattern)

Add a new mapping based on regular expression.

Parameters:

fromPattern - the matching pattern, i.e. /etc/(.*)

toPattern - the replacing pattern, i.e. /dummy/$1/custom

Returns:

this

merge

@NotNull
public @NotNull RegexpPathMapping merge(@Nullable
                                        @Nullable RegexpPathMapping base)

Merges the regexp mapping from the given base mapping.

Parameters:

base - base mapping

Returns:

this

map

@NotNull
public @NotNull String map(@NotNull
                           @NotNull String path)

Maps the given path to a new location.

Specified by:

map in interface PathMapping

Parameters:

path - the path

Returns:

the mapped path.

map

@NotNull
public @NotNull String map(@NotNull
                           @NotNull String path,
                           boolean reverse)

Maps the given path to a new location.

Specified by:

map in interface PathMapping

Parameters:

path - the path

reverse - if true a reverse mapping is applied

Returns:

the mapped path.