gorm.tools.beans.EntityResult.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gorm-tools Show documentation

gorm-tools core

The newest version!

/*
* Copyright 2021 Yak.Works - Licensed under the Apache License, Version 2.0 (the "License")
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*/
package gorm.tools.beans

import groovy.transform.CompileStatic

import yakworks.api.ResultSupport
import yakworks.api.ResultTrait

/**
 * Entity result that allows the instance and some info about its status.
 * Used in upsert for example so we can know if the resulting entity was inserted or updated.
 */
@CompileStatic
class EntityResult implements ResultTrait>, Serializable {
    //the entity this is for
    D entity

    /**
     * New result
     * @param isSynchronized defaults to true to create the data list as synchronizedList
     */
    EntityResult(D entity){
        this.entity = entity
        this.payload = entity
    }

    // ** BUILDERS STATIC OVERRIDES **
    static EntityResult OK(){ throw new UnsupportedOperationException("use generics") }
    static  EntityResult of(D entity) {
        return new EntityResult(entity)
    }
    static  EntityResult ofPayload(D entity) {
        return new EntityResult(entity)
    }

    EntityResult ok(boolean v){
        ok = v
        return this
    }

    /**
     * converts to Map, helpfull for to json and can be overriden on concrete impls
     */
    @Override
    Map asMap(){
        Map hmap = ResultSupport.toMap(this);
        return hmap;
    }

}