fr.xebia.extras.selma

Class Selma

java.lang.Object

fr.xebia.extras.selma.Selma

public class Selma
extends Object

Selma is the only class used to gain access to the Mappers implementations generated at compile time.

It offers a Builder API to retrieve the Mapper you want : // Without sources Selma.builder(MapperInterface.class).build();

// With sources Selma.builder(MapperInterface.class).withSources(sourceInstance).build();

// Without customMapper Selma.builder(MapperInterface.class).withCustomMappers(customMappers).build();

// With sources Selma.builder(MapperInterface.class).withCustomMappers(customMappers).build();

It also offers two simple static methods getMapper(MapperInterface.class) offering the same service level.

Please notice that Selma holds a cache of the instantiated Mappers, and will maintain them as Singleton. You can bypass the cache using the builder API and specifying disableCache() on it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Selma.MapperBuilder<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	SET_CUSTOM_MAPPER
static String	SET_FACTORY

Constructor Summary

Constructors

Constructor and Description
Selma()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> Selma.MapperBuilder<T>	builder(Class<T> mapperClass) Return a builder style component to build the Mapper using this builder you can pass the sources, custom mappers and bypass the default cache registry.
static <T> T	getMapper(Class<T> mapperClass) Mapper Builder DSL for those who like it like that.
static <T> T	getMapper(Class<T> mapperClass, Object source, Object customMapper) Retrieve the generated Mapper for the corresponding interface in the classpath.
static <T> T	getMapperWithCustom(Class<T> mapperClass, Object custom) Retrieve or build the mapper generated for the given interface
static <T> T	mapper(Class<T> mapperClass) Retrieve the generated Mapper for the corresponding interface in the classpath and instantiate it.
static <T> T	mapper(Class<T> mapperClass, Object source) Mapper Builder DSL for those who like it like that.

Methods inherited from class java.lang.Object

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

Field Detail

SET_CUSTOM_MAPPER

public static final String SET_CUSTOM_MAPPER

See Also:

Constant Field Values

SET_FACTORY

public static final String SET_FACTORY

See Also:

Constant Field Values

Constructor Detail

Selma

public Selma()

Method Detail

builder

public static <T> Selma.MapperBuilder<T> builder(Class<T> mapperClass)

Return a builder style component to build the Mapper using this builder you can pass the sources, custom mappers and bypass the default cache registry.

Parameters:

mapperClass - The Mapper interface class

Returns:

a new MapperBuilder used to instantiate the mapper class

Throws:

IllegalArgumentException - If for some reason the Mapper class can not be loaded or instantiated

mapper

public static <T> T mapper(Class<T> mapperClass)
                throws IllegalArgumentException

Retrieve the generated Mapper for the corresponding interface in the classpath and instantiate it.

Type Parameters:

T - The Mapper interface itself

Parameters:

mapperClass - The Mapper interface class

Returns:

A new Mapper instance or previously instantiated selma

Throws:

IllegalArgumentException - If for some reason the Mapper class can not be loaded or instantiated

mapper

public static <T> T mapper(Class<T> mapperClass,
           Object source)

Mapper Builder DSL for those who like it like that.

Type Parameters:

T - The Mapper interface itself

Parameters:

mapperClass - The Mapper interface class

Returns:

Builder for Mapper

getMapper

public static <T> T getMapper(Class<T> mapperClass)

Mapper Builder DSL for those who like it like that.

Type Parameters:

T - The Mapper interface itself

Parameters:

mapperClass - The Mapper interface class

Returns:

Builder for Mapper

getMapperWithCustom

public static <T> T getMapperWithCustom(Class<T> mapperClass,
                        Object custom)

Retrieve or build the mapper generated for the given interface

Type Parameters:

T - The Mapper interface itself

Parameters:

mapperClass - The Mapper interface class

Returns:

Builder for Mapper

getMapper

public static <T> T getMapper(Class<T> mapperClass,
              Object source,
              Object customMapper)
                   throws IllegalArgumentException

Retrieve the generated Mapper for the corresponding interface in the classpath.

Type Parameters:

T - The Mapper interface itself

Parameters:

mapperClass - The Mapper interface class

source - The Source to be passed to bean constructor or null for default

Returns:

A new Mapper instance or previously instantiated selma

Throws:

IllegalArgumentException - If for some reason the Mapper class can not be loaded or instantiated