osgi.enroute.dtos.bndlib.provider

Class DTOsProvider

java.lang.Object

osgi.enroute.dtos.bndlib.provider.DTOsProvider

All Implemented Interfaces:

DTOs

public class DTOsProvider
extends java.lang.Object
implements DTOs

This class provides utility functions for DTOs

Nested Class Summary

Nested classes/interfaces inherited from interface osgi.enroute.dto.api.DTOs

DTOs.Converter, DTOs.Dec<T>, DTOs.Difference, DTOs.Enc, DTOs.LiteralMap<K,V>, DTOs.Reason, DTOs.Retrieve

Constructor Summary

Constructors

Constructor and Description
DTOsProvider()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	asMap(java.lang.Object dto) Return a partially read only Map object that maps directly to a DTO.
DTOs.Converter	convert(java.lang.Object source) Create a converter on an object.
<T> DTOs.Dec<T>	decoder(java.lang.Class<T> type) Return a JSON decoder that uses the type to control the parsing.
DTOs.Dec<?>	decoder(java.lang.reflect.Type type, java.io.InputStream source) Return a JSON decoder on an input stream that uses the type to control the parsing.
<T> DTOs.Dec<T>	decoder(TypeReference<T> type) Return a JSON decoder that uses the type to control the parsing.
<T> T	deepCopy(T source) Deep copy
boolean	deepEquals(java.lang.Object a, java.lang.Object b) Check if two DTOs fields are equal.
java.util.List<DTOs.Difference>	diff(java.lang.Object older, java.lang.Object newer) Return a list of paths where the two objects differ.
DTOs.Enc	encoder(java.lang.Object source) Return encoder builder for JSON
boolean	equals(java.lang.Object a, java.lang.Object b) Check if two dtos fields are equal.
java.lang.String	escape(java.lang.String unescaped) Escape a string to be used in a path.
java.lang.String[]	fromPathToSegments(java.lang.String path) Takes a path with escaped '.'and '\' and then turns it into an array of unescaped keys
java.lang.String	fromSegmentsToPath(java.lang.String[] segments) Takes a path with unescaped keys and turns it into a string path where the \ and .
osgi.enroute.dtos.bndlib.provider.DTOsProvider.Answer	get(java.lang.Object dto, java.lang.String... path) Access a DTO with a path that consists of an array with segments.
osgi.enroute.dtos.bndlib.provider.DTOsProvider.Answer	get(java.lang.Object dto, java.lang.String path) Access a DTO with a path.
<T> java.util.Comparator<T>	getComparator(java.lang.Class<T> dtoClass) Return a comparator who works on the primary fields of a DTO class.
int	hashCode(java.lang.Object dto) Calculate a hash Code for the fields in this DTO.
boolean	isComplex(java.lang.Object a) Return true if the give dto is complex (either Map, Collection, Array, or has public fields.
boolean	isDTO(java.lang.Object o) An object with public fields.
boolean	isValidDTO(java.lang.Object o) Verify that the object is a DTO and has no cycles.
osgi.enroute.dtos.bndlib.provider.DTOsProvider.Answer	set(java.lang.Object dto, java.lang.Object value, java.lang.String... path) Set a value in a DTO with a path that consists of an array with segments.
osgi.enroute.dtos.bndlib.provider.DTOsProvider.Answer	set(java.lang.Object dto, java.lang.Object value, java.lang.String path) Access a DTO with a path.
<T> T	shallowCopy(T source) Shallow copy
java.lang.String	toString(java.lang.Object dto) Convert a DTO to a human readable string presentation.
java.lang.String	unescape(java.lang.String unescaped) Unescapes a string to be used in a path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface osgi.enroute.dto.api.DTOs

map

Constructor Detail

DTOsProvider

public DTOsProvider()

Method Detail

convert

public DTOs.Converter convert(java.lang.Object source)

Description copied from interface: DTOs

Create a converter on an object.

Specified by:

convert in interface DTOs

Parameters:

source - The source to convert, null is allowed

Returns:

a converter for the given source

asMap

public java.util.Map<java.lang.String,java.lang.Object> asMap(java.lang.Object dto)
                                                       throws java.lang.Exception

Description copied from interface: DTOs

Return a partially read only Map object that maps directly to a DTO. I.e. changes are reflected in the DTO. If a field is a DTO, then this field will also become a Map.

Specified by:

asMap in interface DTOs

Parameters:

dto - the DTO

Returns:

a Map where the keys map to the field names and the values to the field values. This map is not modifiable.

Throws:

java.lang.Exception

toString

public java.lang.String toString(java.lang.Object dto)

Description copied from interface: DTOs

Convert a DTO to a human readable string presentation. This is primarily for debugging since the toString can truncate fields. This method must print all public fields, also non primary. Output formats can vary (e.g. YAML like) so the actual output should NOT be treated as standard.

Specified by:

toString in interface DTOs

Parameters:

dto - the dto to turn into a string

Returns:

a human readable string (not json!)

equals

public boolean equals(java.lang.Object a,
                      java.lang.Object b)

Description copied from interface: DTOs

Check if two dtos fields are equal. This is shallow equal, that is the fields of this DTO are using the equals() instance method.

Specified by:

equals in interface DTOs

Parameters:

a - the first object

b - the second object

Returns:

true if both are null or the DTO's primary fields are equal

hashCode

public int hashCode(java.lang.Object dto)

Description copied from interface: DTOs

Calculate a hash Code for the fields in this DTO. The dto must have at least one public field.

Specified by:

hashCode in interface DTOs

Parameters:

dto - the object to calculate the hashcode for, must not be null .

Returns:

a hashcode

get

public osgi.enroute.dtos.bndlib.provider.DTOsProvider.Answer get(java.lang.Object dto,
                                                                 java.lang.String path)
                                                          throws java.lang.Exception

Description copied from interface: DTOs

Access a DTO with a path. A path is a '.' separated string. Each part in the path is either a field name, key in a map, or an index in a list. If the path segments contain dots or backslashes, then these must be escaped

Specified by:

get in interface DTOs

Parameters:

dto - the root

path - the path, should only contain dots as separators

Returns:

the value of the object or null if not found.

Throws:

java.lang.Exception

get

public osgi.enroute.dtos.bndlib.provider.DTOsProvider.Answer get(java.lang.Object dto,
                                                                 java.lang.String... path)
                                                          throws java.lang.Exception

Description copied from interface: DTOs

Access a DTO with a path that consists of an array with segments. Each segment in the path is either a field name, key in a map, or an index in a list.

Specified by:

get in interface DTOs

Parameters:

dto - the root

path - the path

Returns:

the value of the object or null if not found.

Throws:

java.lang.Exception

set

public osgi.enroute.dtos.bndlib.provider.DTOsProvider.Answer set(java.lang.Object dto,
                                                                 java.lang.Object value,
                                                                 java.lang.String path)
                                                          throws java.lang.Exception

Description copied from interface: DTOs

Access a DTO with a path. A path is a '.' separated string. Each part in the path is either a field name, key in a map, or an index in a list. Maps and Lists are extended to hold the new value. This method does not support dots in the path. For paths with dots in the keys, use DTOs.get(Object, String...).

Specified by:

set in interface DTOs

Parameters:

dto - the root

value - the value to set

path - the path, should only contain dots as separators

Returns:

the value of the object or null if not found.

Throws:

java.lang.Exception

set

public osgi.enroute.dtos.bndlib.provider.DTOsProvider.Answer set(java.lang.Object dto,
                                                                 java.lang.Object value,
                                                                 java.lang.String... path)
                                                          throws java.lang.Exception

Description copied from interface: DTOs

Set a value in a DTO with a path that consists of an array with segments. Each segment in the path is either a field name, key in a map, or an index in a list.

Specified by:

set in interface DTOs

Parameters:

dto - the root

value - the value to set

path - the path

Returns:

the value of the object or null if not found.

Throws:

java.lang.Exception

diff

public java.util.List<DTOs.Difference> diff(java.lang.Object older,
                                            java.lang.Object newer)
                                     throws java.lang.Exception

Description copied from interface: DTOs

Return a list of paths where the two objects differ. The objects must be of the same class.

Specified by:

diff in interface DTOs

Parameters:

older - the older object

newer - the newer object

Returns:

A list of differences, if there is no difference, the list is empty.

Throws:

java.lang.Exception

escape

public java.lang.String escape(java.lang.String unescaped)

Description copied from interface: DTOs

Escape a string to be used in a path. This will put a backslash ('\') in front of full stops ('.') and the backslash ('\').

Specified by:

escape in interface DTOs

Parameters:

unescaped - the string to be escaped

Returns:

a string where all '.' and '\' are escaped with a '\'.

unescape

public java.lang.String unescape(java.lang.String unescaped)

Description copied from interface: DTOs

Unescapes a string to be used in a path. This will remove a backslash ('\') in front of full stops ('.') and the backslash ('\').

Specified by:

unescape in interface DTOs

Parameters:

unescaped - the string to be unescaped

Returns:

a string where all '\.' and '\\' have the preceding backslash removed with a '\'.

isComplex

public boolean isComplex(java.lang.Object a)

Description copied from interface: DTOs

Return true if the give dto is complex (either Map, Collection, Array, or has public fields.

Specified by:

isComplex in interface DTOs

Parameters:

a - The DTO to check

Returns:

true if this is a DTO with fields or length.

isDTO

public boolean isDTO(java.lang.Object o)

Description copied from interface: DTOs

An object with public fields.

Specified by:

isDTO in interface DTOs

Parameters:

o - the object to check

Returns:

true if this object has public fields or extends DTO

encoder

public DTOs.Enc encoder(java.lang.Object source)
                 throws java.lang.Exception

Description copied from interface: DTOs

Return encoder builder for JSON

Specified by:

encoder in interface DTOs

Parameters:

source - the object to encode

Returns:

a builder to control the encoding

Throws:

java.lang.Exception

decoder

public <T> DTOs.Dec<T> decoder(java.lang.Class<T> type)
                        throws java.lang.Exception

Description copied from interface: DTOs

Return a JSON decoder that uses the type to control the parsing.

Specified by:

decoder in interface DTOs

Parameters:

type - the type that controls actual types for parsing

Returns:

a decoder

Throws:

java.lang.Exception

decoder

public <T> DTOs.Dec<T> decoder(TypeReference<T> type)
                        throws java.lang.Exception

Description copied from interface: DTOs

Return a JSON decoder that uses the type to control the parsing.

Specified by:

decoder in interface DTOs

Parameters:

type - the type that controls actual types for parsing

Returns:

a decoder

Throws:

java.lang.Exception

decoder

public DTOs.Dec<?> decoder(java.lang.reflect.Type type,
                           java.io.InputStream source)
                    throws java.lang.Exception

Description copied from interface: DTOs

Return a JSON decoder on an input stream that uses the type to control the parsing.

Specified by:

decoder in interface DTOs

Parameters:

type - the type that controls actual types for parsing

source - the source of the JSON

Returns:

a decoder

Throws:

java.lang.Exception

getComparator

public <T> java.util.Comparator<T> getComparator(java.lang.Class<T> dtoClass)

Description copied from interface: DTOs

Return a comparator who works on the primary fields of a DTO class.

Specified by:

getComparator in interface DTOs

Parameters:

dtoClass - the dto class

Returns:

a comparator for the given DTO or null if the dtoClass has no fields of a comparable type. If a field has public fields and these are comparable then they are also included recursively.

shallowCopy

public <T> T shallowCopy(T source)
                  throws java.lang.Exception

Shallow copy

Specified by:

shallowCopy in interface DTOs

Parameters:

source - the source object

Returns:

a shallow copy of object

Throws:

java.lang.Exception

deepCopy

public <T> T deepCopy(T source)
               throws java.lang.Exception

Deep copy

Specified by:

deepCopy in interface DTOs

Parameters:

source - the object to deep copy

Returns:

the deep copied object

Throws:

java.lang.Exception

fromPathToSegments

public java.lang.String[] fromPathToSegments(java.lang.String path)

Description copied from interface: DTOs

Takes a path with escaped '.'and '\' and then turns it into an array of unescaped keys

Specified by:

fromPathToSegments in interface DTOs

Parameters:

path - the path with escaped \ and .

Returns:

a path array with unescaped segments

fromSegmentsToPath

public java.lang.String fromSegmentsToPath(java.lang.String[] segments)

Description copied from interface: DTOs

Takes a path with unescaped keys and turns it into a string path where the \ and . are escaped.

Specified by:

fromSegmentsToPath in interface DTOs

Parameters:

segments - The unescaped segments of the path

Returns:

a string path where the . and \ are escaped.

deepEquals

public boolean deepEquals(java.lang.Object a,
                          java.lang.Object b)

Description copied from interface: DTOs

Check if two DTOs fields are equal. This is deep equal, that is the fields of this DTO are using this method is the object at a field is a DTO, recursively.

Specified by:

deepEquals in interface DTOs

Parameters:

a - the first object

b - the second object

Returns:

true if both are null or the DTO's primary fields are equal

isValidDTO

public boolean isValidDTO(java.lang.Object o)
                   throws java.lang.Exception

Description copied from interface: DTOs

Verify that the object is a DTO and has no cycles.

Specified by:

isValidDTO in interface DTOs

Parameters:

o - The object to check for no cycles

Returns:

true if this DTO has no cycles and is further ok

Throws:

java.lang.Exception