com.github.robtimus.obfuscation.xml

Interface XMLObfuscator.ElementConfigurer

All Superinterfaces:

XMLObfuscator.Builder

Enclosing class:

XMLObfuscator

public static interface XMLObfuscator.ElementConfigurer
extends XMLObfuscator.Builder

An object that can be used to configure an element that should be obfuscated.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	XMLObfuscator.ElementConfigurer.ObfuscationMode The possible ways to deal with nested elements.

Method Summary

Modifier and Type	Method and Description
default XMLObfuscator.ElementConfigurer	all() Indicates that elements nested in elements with the current name will be obfuscated.
default XMLObfuscator.ElementConfigurer	excludeNestedElements() Indicates that elements nested in elements with the current name will not be obfuscated.
XMLObfuscator.ElementConfigurer	forNestedElements(XMLObfuscator.ElementConfigurer.ObfuscationMode obfuscationMode) Indicates how to handle nested elements.
default XMLObfuscator.ElementConfigurer	includeNestedElements() Indicates that elements nested in elements with the current name will be obfuscated.
default XMLObfuscator.ElementConfigurer	textOnly() Indicates that elements nested in elements with the current name will not be obfuscated.

Methods inherited from interface com.github.robtimus.obfuscation.xml.XMLObfuscator.Builder

allByDefault, build, caseInsensitiveByDefault, caseSensitiveByDefault, excludeNestedElementsByDefault, forNestedElementsByDefault, generateXML, includeNestedElementsByDefault, limitTo, textOnlyByDefault, transform, withAttribute, withAttribute, withAttribute, withElement, withElement, withElement, withMalformedXMLWarning

Method Detail

textOnly

default XMLObfuscator.ElementConfigurer textOnly()

Indicates that elements nested in elements with the current name will not be obfuscated. This method is shorthand for calling both excludeNestedElements().

Returns:

This object.

excludeNestedElements

default XMLObfuscator.ElementConfigurer excludeNestedElements()

Indicates that elements nested in elements with the current name will not be obfuscated. This method is an alias for forNestedElements(ObfuscationMode) in combination with XMLObfuscator.ElementConfigurer.ObfuscationMode.EXCLUDE.

Returns:

This object.

all

default XMLObfuscator.ElementConfigurer all()

Indicates that elements nested in elements with the current name will be obfuscated. This method is shorthand for calling includeNestedElements().

Returns:

This object.

includeNestedElements

default XMLObfuscator.ElementConfigurer includeNestedElements()

Indicates that elements nested in elements with the current name will be obfuscated. This method is an alias for forNestedElements(ObfuscationMode) in combination with XMLObfuscator.ElementConfigurer.ObfuscationMode.INHERIT.

Returns:

This object.

forNestedElements

XMLObfuscator.ElementConfigurer forNestedElements(XMLObfuscator.ElementConfigurer.ObfuscationMode obfuscationMode)

Indicates how to handle nested elements. The default is XMLObfuscator.ElementConfigurer.ObfuscationMode.INHERIT.

Parameters:

obfuscationMode - The obfuscation mode that determines how to handle nested elements.

Returns:

This object.

Throws:

NullPointerException - If the given obfuscation mode is null.

Since:

1.4