org.srplib.conversion.mapper

Class MatcherMapBuilder<I,O>

java.lang.Object

org.srplib.conversion.mapper.MatcherMapBuilder<I,O>

public class MatcherMapBuilder<I,O>
extends java.lang.Object

A builder for creating MatcherMapConverter.

  MatcherMapConverter codeToMessageConverter = MatcherMapBuilder.create()
      .setDefaultValue("Unknown error!")
      .map("200", "Ok")
      .map(new RegexMatcher("3.."), "Redirect!")
      .map(new RegexMatcher("4.."), "Client error!")
      .map(new RegexMatcher("5.."), "Server error!")
      .build();

  String message = codeToMessageConverter.convert(httpStatusCode);
 

Constructor Summary

Constructors

Constructor and Description
MatcherMapBuilder() MatcherMapBuilder constructor with no mapping and null default value.
MatcherMapBuilder(java.util.Map<org.hamcrest.Matcher<I>,O> matcherMap, O defaultValue) MatcherMapBuilder constructor with predefined matcher map and specified default value.

Method Summary

Modifier and Type	Method and Description
MatcherMapConverter<I,O>	build() Create MatcherMapConverter basing on previously specified parameters.
static <I,O> MatcherMapBuilder<I,O>	create() Creates empty mapper.
static <I,O> MatcherMapBuilder<I,O>	create(java.util.Map<I,O> map) Creates mapper from specified map.
MatcherMapBuilder<I,O>	map(I input, O output) Maps specified source value to specified output value.
MatcherMapBuilder<I,O>	map(org.hamcrest.Matcher<I> matcher, O value) Maps specified Harcrest matcher to value.
MatcherMapBuilder<I,O>	setDefaultValue(O defaultValue) Set default value.
MatcherMapBuilder<I,O>	setNoMatchMessagePattern(java.lang.String pattern) Set message pattern to be used to construct error message when no matches is found.
MatcherMapBuilder<I,O>	throwExceptionOnNoMatch(boolean throwExceptionOnNoMatch) Specifies whether to throw an exception if no match is found and no default value is specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatcherMapBuilder

public MatcherMapBuilder()

MatcherMapBuilder constructor with no mapping and null default value.

MatcherMapBuilder

public MatcherMapBuilder(java.util.Map<org.hamcrest.Matcher<I>,O> matcherMap,
                         O defaultValue)

MatcherMapBuilder constructor with predefined matcher map and specified default value.

Parameters:

matcherMap - Map, O> a non-null matcher to an object map

defaultValue - default value object

Throws:

java.lang.IllegalArgumentException - if matcherMap is is null

Method Detail

create

public static <I,O> MatcherMapBuilder<I,O> create()

Creates empty mapper.

Type Parameters:

I - source type

O - target type

Returns:

MatcherMapBuilder empty mapper.

create

public static <I,O> MatcherMapBuilder<I,O> create(java.util.Map<I,O> map)

Creates mapper from specified map.

Type Parameters:

I - source type

O - target type

Parameters:

map - Map a map to create mapper from.

Returns:

MatcherMapBuilder mapper.

setDefaultValue

public MatcherMapBuilder<I,O> setDefaultValue(O defaultValue)

Set default value.

Default value is used when no mapping is found for an object.

Parameters:

defaultValue - Object default value.

Returns:

this

setNoMatchMessagePattern

public MatcherMapBuilder<I,O> setNoMatchMessagePattern(java.lang.String pattern)

Set message pattern to be used to construct error message when no matches is found.

Parameters:

pattern - String message pattern with single string placeholder '%s'

throwExceptionOnNoMatch

public MatcherMapBuilder<I,O> throwExceptionOnNoMatch(boolean throwExceptionOnNoMatch)

Specifies whether to throw an exception if no match is found and no default value is specified.

Parameters:

throwExceptionOnNoMatch - boolean a flag. Default value is true.

map

public MatcherMapBuilder<I,O> map(org.hamcrest.Matcher<I> matcher,
                                  O value)

Maps specified Harcrest matcher to value.

This is the most flexible method. It's acceptable to pass any matcher from Harmcrest matcher library.

Parameters:

matcher - Matcher hamcrest matcher

value - value to map

Returns:

this

map

public MatcherMapBuilder<I,O> map(I input,
                                  O output)

Maps specified source value to specified output value.

Parameters:

input - source value

output - target value

Returns:

this

build

public MatcherMapConverter<I,O> build()

Create MatcherMapConverter basing on previously specified parameters.

Returns:

MatcherMapConverter a converter.