Package cdc.util.data.util

Interface AttributeValueConverter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface AttributeValueConverter

Interface used to convert (replace) an attribute value.

Author:

Damien Carbonne

Field Summary

Fields

Modifier and Type	Field	Description
static AttributeValueConverter	INDENTITY	An attribute value converter that returns the value unchanged.

Method Summary

Modifier and Type	Method	Description
default AttributeValueConverter	andThen(AttributeValueConverter other)	Returns a converter that first applies this converter and then other.
default AttributeValueConverter	compose(AttributeValueConverter other)	Returns a converter that first applies other then this converter.
java.lang.String	convertAttributeValue(Element element, java.lang.String name, java.lang.String value)	Returns the value that should be used instead of the original value.
static AttributeValueConverter	fromNameMap(java.util.Map<java.lang.String,java.lang.String> map)	Creates a new AttributeValueConverter from an attribute name to value map.
static AttributeValueConverter	fromPathMap(java.util.Map<SPath,java.lang.String> map)
static AttributeValueConverter	fromString(java.lang.String s)
static AttributeValueConverter	fromValueFunction(java.util.function.Function<java.lang.String,java.lang.String> function)	Creates a new AttributeValueConverter from a value converter function.
static AttributeValueConverter	fromValueMap(java.util.Map<java.lang.String,java.lang.String> map)	Creates a new AttributeValueConverter from an attribute value map.
static AttributeValueConverter	scramble(boolean preserveSpaces)

Field Detail

INDENTITY

static final AttributeValueConverter INDENTITY

An attribute value converter that returns the value unchanged.

Method Detail

convertAttributeValue

java.lang.String convertAttributeValue(Element element,
                                       java.lang.String name,
                                       java.lang.String value)

Returns the value that should be used instead of the original value.

Parameters:

element - The element containing the attribute.

name - The attribute name.

value - The attribute value.

Returns:

The value to use for the attribute (instead of value).

compose

default AttributeValueConverter compose(AttributeValueConverter other)

Returns a converter that first applies other then this converter.

Parameters:

other - The other converter.

Returns:

A converter that first applies other then this converter.

Throws:

java.lang.IllegalArgumentException - When other is null.

andThen

default AttributeValueConverter andThen(AttributeValueConverter other)

Returns a converter that first applies this converter and then other.

Parameters:

other - The other converter.

Returns:

A converter that first applies this converter and then other.

Throws:

java.lang.IllegalArgumentException - When other is null.

fromString

static AttributeValueConverter fromString(java.lang.String s)

scramble

static AttributeValueConverter scramble(boolean preserveSpaces)

fromValueFunction

static AttributeValueConverter fromValueFunction(java.util.function.Function<java.lang.String,java.lang.String> function)

Creates a new AttributeValueConverter from a value converter function.

Conversion is independent of element and attribute name.

Parameters:

function - The function used to convert values.

Returns:

A new AttributeValueConverter from function.

Throws:

java.lang.IllegalArgumentException - When function is null.

fromValueMap

static AttributeValueConverter fromValueMap(java.util.Map<java.lang.String,java.lang.String> map)

Creates a new AttributeValueConverter from an attribute value map.

Conversion is independent of element and attribute name.
If a value is not mapped, then result is that value.

Parameters:

map - The map.

Returns:

A new AttributeValueConverter from map.

Throws:

java.lang.IllegalArgumentException - When map is null.

fromNameMap

static AttributeValueConverter fromNameMap(java.util.Map<java.lang.String,java.lang.String> map)

Creates a new AttributeValueConverter from an attribute name to value map.

If a name is not mapped, then result is original value.

Parameters:

map - The map.

Returns:

A new AttributeValueConverter from map.

fromPathMap

static AttributeValueConverter fromPathMap(java.util.Map<SPath,java.lang.String> map)