// --------------------------------------------------------------------------------
// Copyright 2002-2026 Echo Three, LLC
//
// 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.
// --------------------------------------------------------------------------------
// Generated File -- DO NOT EDIT BY HAND
// --------------------------------------------------------------------------------

/**
 * EntityInstanceValue.java
 */

package com.echothree.model.data.core.server.value;

import com.echothree.model.data.core.common.pk.EntityInstancePK;

import com.echothree.model.data.core.server.factory.EntityInstanceFactory;

import com.echothree.model.data.core.common.pk.EntityTypePK;

import com.echothree.util.common.exception.PersistenceCloneException;
import com.echothree.util.common.exception.PersistenceNotNullException;

import com.echothree.util.server.persistence.BaseValue;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class EntityInstanceValue
        extends BaseValue<EntityInstancePK>
        implements Cloneable, Serializable {
    
    private EntityTypePK entityTypePK;
    private boolean entityTypePKHasBeenModified = false;
    private Long entityUniqueId;
    private boolean entityUniqueIdHasBeenModified = false;
    private String uuid;
    private boolean uuidHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(EntityTypePK entityTypePK, Long entityUniqueId, String uuid)
            throws PersistenceNotNullException {
        checkForNull(entityTypePK);
        this.entityTypePK = entityTypePK;
        checkForNull(entityUniqueId);
        this.entityUniqueId = entityUniqueId;
        this.uuid = uuid;
    }
    
    /** Creates a new instance of EntityInstanceValue */
    public EntityInstanceValue(EntityInstancePK entityInstancePK, EntityTypePK entityTypePK, Long entityUniqueId, String uuid)
            throws PersistenceNotNullException {
        super(entityInstancePK);
        constructFields(entityTypePK, entityUniqueId, uuid);
    }
    
    /** Creates a new instance of EntityInstanceValue */
    public EntityInstanceValue(EntityTypePK entityTypePK, Long entityUniqueId, String uuid)
            throws PersistenceNotNullException {
        super();
        constructFields(entityTypePK, entityUniqueId, uuid);
    }
    
    @Override
    @Nonnull
    public EntityInstanceFactory getBaseFactoryInstance() {
        return EntityInstanceFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public EntityInstanceValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (EntityInstanceValue)result;
    }
    
    @Override
    @Nonnull
    public EntityInstancePK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new EntityInstancePK(entityId);
        }
        
        return _primaryKey;
    }
    
    private void clearHashAndString() {
        _hashCode = null;
        _stringValue = null;
    }
    
    @Override
    public int hashCode() {
        if(_hashCode == null) {
            int hashCode = 17;
            
            hashCode = 37 * hashCode + ((entityId != null) ? entityId.hashCode() : 0);
            
            hashCode = 37 * hashCode + ((entityTypePK != null) ? entityTypePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((entityUniqueId != null) ? entityUniqueId.hashCode() : 0);
            hashCode = 37 * hashCode + ((uuid != null) ? uuid.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", entityTypePK=" + getEntityTypePK() +
                    ", entityUniqueId=" + getEntityUniqueId() +
                    ", uuid=" + getUuid() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  EntityInstanceValue that) {
            if(!that.hasIdentity())
                return false;
            
            Long thisEntityId = getEntityId();
            Long thatEntityId = that.getEntityId();
            
            boolean objectsEqual = thisEntityId.equals(thatEntityId);
            if(objectsEqual)
                objectsEqual = isIdentical(that);
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    public boolean isIdentical(Object other) {
        if(other instanceof EntityInstanceValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                EntityTypePK thisEntityTypePK = getEntityTypePK();
                EntityTypePK thatEntityTypePK = that.getEntityTypePK();
                
                if(thisEntityTypePK == null) {
                    objectsEqual = objectsEqual && (thatEntityTypePK == null);
                } else {
                    objectsEqual = objectsEqual && thisEntityTypePK.equals(thatEntityTypePK);
                }
            }
            
            if(objectsEqual) {
                Long thisEntityUniqueId = getEntityUniqueId();
                Long thatEntityUniqueId = that.getEntityUniqueId();
                
                if(thisEntityUniqueId == null) {
                    objectsEqual = objectsEqual && (thatEntityUniqueId == null);
                } else {
                    objectsEqual = objectsEqual && thisEntityUniqueId.equals(thatEntityUniqueId);
                }
            }
            
            if(objectsEqual) {
                String thisUuid = getUuid();
                String thatUuid = that.getUuid();
                
                if(thisUuid == null) {
                    objectsEqual = objectsEqual && (thatUuid == null);
                } else {
                    objectsEqual = objectsEqual && thisUuid.equals(thatUuid);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return entityTypePKHasBeenModified || entityUniqueIdHasBeenModified || uuidHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        entityTypePKHasBeenModified = false;
        entityUniqueIdHasBeenModified = false;
        uuidHasBeenModified = false;
    }
    
    @Nonnull
    public EntityTypePK getEntityTypePK() {
        return entityTypePK;
    }
    
    public void setEntityTypePK(@Nonnull EntityTypePK entityTypePK)
            throws PersistenceNotNullException {
        checkForNull(entityTypePK);
        
        boolean update = true;
        
        if(this.entityTypePK != null) {
            if(this.entityTypePK.equals(entityTypePK)) {
                update = false;
            }
        } else if(entityTypePK == null) {
            update = false;
        }
        
        if(update) {
            this.entityTypePK = entityTypePK;
            entityTypePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getEntityTypePKHasBeenModified() {
        return entityTypePKHasBeenModified;
    }
    
    @Nonnull
    public Long getEntityUniqueId() {
        return entityUniqueId;
    }
    
    public void setEntityUniqueId(@Nonnull Long entityUniqueId)
            throws PersistenceNotNullException {
        checkForNull(entityUniqueId);
        
        boolean update = true;
        
        if(this.entityUniqueId != null) {
            if(this.entityUniqueId.equals(entityUniqueId)) {
                update = false;
            }
        } else if(entityUniqueId == null) {
            update = false;
        }
        
        if(update) {
            this.entityUniqueId = entityUniqueId;
            entityUniqueIdHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getEntityUniqueIdHasBeenModified() {
        return entityUniqueIdHasBeenModified;
    }
    
    @Nullable
    public String getUuid() {
        return uuid;
    }
    
    public void setUuid(@Nullable String uuid) {
        boolean update = true;
        
        if(this.uuid != null) {
            if(this.uuid.equals(uuid)) {
                update = false;
            }
        } else if(uuid == null) {
            update = false;
        }
        
        if(update) {
            this.uuid = uuid;
            uuidHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getUuidHasBeenModified() {
        return uuidHasBeenModified;
    }
    
}