jetbrains.buildServer.web.util

Class RegExpTextTransformer

java.lang.Object

jetbrains.buildServer.web.util.RegExpTextTransformer

All Implemented Interfaces:

MainConfigProcessor, ServerExtension, TeamCityExtension, XmlExternalizable, XmlStorable

public class RegExpTextTransformer
extends java.lang.Object
implements MainConfigProcessor

This class provides facility to process text with configurable regexp patterns

Author:

AG, Maxim Podkolzine, Oleg Rybak (oleg.rybak@jetbrains.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegExpTextTransformer.PatternBuilder
static class	RegExpTextTransformer.TransformPattern

Constructor Summary

Constructors

Constructor and Description
RegExpTextTransformer(SBuildServer buildServer)

Method Summary

Modifier and Type	Method and Description
static void	addTransformPattern(RegExpTextTransformer.TransformPattern pattern)
static void	addTransformPattern(RegExpTextTransformer.TransformPattern pattern, boolean replace, java.lang.Integer index) Deprecated.
static void	addTransformPattern(RegExpTextTransformer.TransformPattern pattern, boolean replace, java.lang.Integer index, java.lang.String projectId)
static void	clearPatterns()
static java.lang.String	format(java.lang.String text, javax.servlet.jsp.JspContext context) Formats given text in supplied context Order of applying transformation patterns: 1) Global static patterns 2) Global dynamic patterns 3) Project-related patterns (in leaf-to-root order) 3.1) Project-related static patterns 3.2) Project-related dynamic patterns
static java.lang.String	format(java.lang.String text, WebContext webContext) Formats given text in supplied context Order of applying transformation patterns: 1) Global static patterns 2) Global dynamic patterns 3) Project-related patterns (in leaf-to-root order) 3.1) Project-related static patterns 3.2) Project-related dynamic patterns
void	readFrom(org.jdom.Element rootElement) Read this element data from given JDOM node
static void	removeTransformPattern(java.lang.String description) Deprecated.
static void	removeTransformPattern(java.lang.String description, java.lang.String projectId)
void	writeTo(org.jdom.Element parentElement) Write data to the JDOM element

Methods inherited from class java.lang.Object

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

Constructor Detail

RegExpTextTransformer

public RegExpTextTransformer(@NotNull
                             SBuildServer buildServer)

Method Detail

format

public static java.lang.String format(@NotNull
                                      java.lang.String text,
                                      @NotNull
                                      javax.servlet.jsp.JspContext context)

Formats given text in supplied context Order of applying transformation patterns: 1) Global static patterns 2) Global dynamic patterns 3) Project-related patterns (in leaf-to-root order) 3.1) Project-related static patterns 3.2) Project-related dynamic patterns

Parameters:

text - text to format

context - transformation context

Returns:

transformed text

See Also:

RegExpTextTransformer.TransformPattern, addTransformPattern(jetbrains.buildServer.web.util.RegExpTextTransformer.TransformPattern), (jetbrains.buildServer.web.util.RegExpTextTransformer.TransformPattern)

format

@NotNull
public static java.lang.String format(@NotNull
                                               java.lang.String text,
                                               WebContext webContext)

Formats given text in supplied context Order of applying transformation patterns: 1) Global static patterns 2) Global dynamic patterns 3) Project-related patterns (in leaf-to-root order) 3.1) Project-related static patterns 3.2) Project-related dynamic patterns

Parameters:

text - text to format

webContext - transformation context

Returns:

transformed text

See Also:

RegExpTextTransformer.TransformPattern, addTransformPattern(jetbrains.buildServer.web.util.RegExpTextTransformer.TransformPattern), (jetbrains.buildServer.web.util.RegExpTextTransformer.TransformPattern)

readFrom

public void readFrom(@NotNull
                     org.jdom.Element rootElement)

Description copied from interface: XmlStorable

Read this element data from given JDOM node

Specified by:

readFrom in interface XmlStorable

Parameters:

rootElement - element which contains information about this storable

writeTo

public void writeTo(@NotNull
                    org.jdom.Element parentElement)

Description copied from interface: XmlExternalizable

Write data to the JDOM element

Specified by:

writeTo in interface XmlExternalizable

Parameters:

parentElement - - parent element to write data to

addTransformPattern

public static void addTransformPattern(@NotNull
                                       RegExpTextTransformer.TransformPattern pattern)

addTransformPattern

@Deprecated
public static void addTransformPattern(@NotNull
                                                   RegExpTextTransformer.TransformPattern pattern,
                                                   boolean replace,
                                                   @Nullable
                                                   java.lang.Integer index)

Deprecated.

addTransformPattern

public static void addTransformPattern(@NotNull
                                       RegExpTextTransformer.TransformPattern pattern,
                                       boolean replace,
                                       @Nullable
                                       java.lang.Integer index,
                                       @Nullable
                                       java.lang.String projectId)

removeTransformPattern

@Deprecated
public static void removeTransformPattern(@NotNull
                                                      java.lang.String description)

Deprecated.

removeTransformPattern

public static void removeTransformPattern(@NotNull
                                          java.lang.String description,
                                          @Nullable
                                          java.lang.String projectId)

clearPatterns

public static void clearPatterns()