https://github.com/malekkamel/modelmapper
https://github.com/malekkamel/modelmapper
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/malekkamel/modelmapper
- Owner: MalekKamel
- Created: 2019-12-07T22:34:56.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-14T07:41:52.000Z (almost 6 years ago)
- Last Synced: 2025-01-27T15:43:32.918Z (9 months ago)
- Language: Kotlin
- Size: 261 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ModelMapper
================
An abstraction for mapping models, write a mapper once, use everywhere.
It's a best practice, like in clean architecture, to create a model for reach domain, for example a DTO for network response, Entity for database, and so on. But mapping each model is something painful as you have to map objects, lists and deal with nullables. Here's where **ModelMapper** shines, just create a single mapper for the object and use it to map objects, Lists, and nullable Lists.
# Usage
``` kotlin
// Declare mapper
class UserMapper: Mapper {
override fun map(input: UserDto): User = User(name = input.name, email = input.email)
}
// map UserDto to User
val user: User = UserMapper().map(userDto)
// map List to List
val input: List = listOf(userDto, userDto)
val users: List = ListMapper(UserMapper()).map(input)
// map List? to List
val input: List? = null
val users: List = NullableInputListMapper(UserMapper()).map(input)
// map List to List?
val input: List = emptyList()
val users: List? = NullableOutputListMapper(UserMapper()).map(input)
// map List? to List?
var input: List? = null
val users = NullableListMapper(UserMapper()).map(input)
```
#### Gradle:
```groovy
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
dependencies {
implementation 'com.github.ShabanKamell:ModelMapper:x.y.z'
}
```
(Please replace x, y and z with the latest version numbers: [](https://jitpack.io/#ShabanKamell/ModelMapper))
### License
click to reveal License
```
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```