SmashKs/OneShoot

/*
 * Copyright (C) 2018 The Smash Ks Open Project
 *
 * 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.
 */

package smash.ks.com.oneshoot.entities.mappers

import org.modelmapper.ModelMapper
import smash.ks.com.domain.models.Model
import smash.ks.com.oneshoot.entities.Entity

/**
 * The mapper is used to transition the object between [Model] and [Entity].
 */
abstract class Mapper<M : Model, E : Entity>(protected val mapper: ModelMapper) {
    /**
     * Transition the [Model] object to [Entity] object.
     *
     * @param model a [Model] model object.
     * @return the same content's [Entity] object.
     */
    abstract fun toEntityFrom(model: M): E

    /**
     * Transition the [Model] object to [Entity] object.
     *
     * @param entity a [Entity] data object.
     * @return the same content's [Model] object.
     */
    abstract fun toModelFrom(entity: E): M
}