// --------------------------------------------------------------------------------
// 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
// --------------------------------------------------------------------------------

/**
 * QueuedLetterValue.java
 */

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

import com.echothree.model.data.letter.common.pk.QueuedLetterPK;

import com.echothree.model.data.letter.server.factory.QueuedLetterFactory;

import com.echothree.model.data.chain.common.pk.ChainInstancePK;
import com.echothree.model.data.letter.common.pk.LetterPK;

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 QueuedLetterValue
        extends BaseValue<QueuedLetterPK>
        implements Cloneable, Serializable {
    
    private ChainInstancePK chainInstancePK;
    private boolean chainInstancePKHasBeenModified = false;
    private Integer queuedLetterSequence;
    private boolean queuedLetterSequenceHasBeenModified = false;
    private LetterPK letterPK;
    private boolean letterPKHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(ChainInstancePK chainInstancePK, Integer queuedLetterSequence, LetterPK letterPK)
            throws PersistenceNotNullException {
        checkForNull(chainInstancePK);
        this.chainInstancePK = chainInstancePK;
        checkForNull(queuedLetterSequence);
        this.queuedLetterSequence = queuedLetterSequence;
        checkForNull(letterPK);
        this.letterPK = letterPK;
    }
    
    /** Creates a new instance of QueuedLetterValue */
    public QueuedLetterValue(QueuedLetterPK queuedLetterPK, ChainInstancePK chainInstancePK, Integer queuedLetterSequence, LetterPK letterPK)
            throws PersistenceNotNullException {
        super(queuedLetterPK);
        constructFields(chainInstancePK, queuedLetterSequence, letterPK);
    }
    
    /** Creates a new instance of QueuedLetterValue */
    public QueuedLetterValue(ChainInstancePK chainInstancePK, Integer queuedLetterSequence, LetterPK letterPK)
            throws PersistenceNotNullException {
        super();
        constructFields(chainInstancePK, queuedLetterSequence, letterPK);
    }
    
    @Override
    @Nonnull
    public QueuedLetterFactory getBaseFactoryInstance() {
        return QueuedLetterFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public QueuedLetterValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (QueuedLetterValue)result;
    }
    
    @Override
    @Nonnull
    public QueuedLetterPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new QueuedLetterPK(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 + ((chainInstancePK != null) ? chainInstancePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((queuedLetterSequence != null) ? queuedLetterSequence.hashCode() : 0);
            hashCode = 37 * hashCode + ((letterPK != null) ? letterPK.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", chainInstancePK=" + getChainInstancePK() +
                    ", queuedLetterSequence=" + getQueuedLetterSequence() +
                    ", letterPK=" + getLetterPK() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  QueuedLetterValue 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 QueuedLetterValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                ChainInstancePK thisChainInstancePK = getChainInstancePK();
                ChainInstancePK thatChainInstancePK = that.getChainInstancePK();
                
                if(thisChainInstancePK == null) {
                    objectsEqual = objectsEqual && (thatChainInstancePK == null);
                } else {
                    objectsEqual = objectsEqual && thisChainInstancePK.equals(thatChainInstancePK);
                }
            }
            
            if(objectsEqual) {
                Integer thisQueuedLetterSequence = getQueuedLetterSequence();
                Integer thatQueuedLetterSequence = that.getQueuedLetterSequence();
                
                if(thisQueuedLetterSequence == null) {
                    objectsEqual = objectsEqual && (thatQueuedLetterSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisQueuedLetterSequence.equals(thatQueuedLetterSequence);
                }
            }
            
            if(objectsEqual) {
                LetterPK thisLetterPK = getLetterPK();
                LetterPK thatLetterPK = that.getLetterPK();
                
                if(thisLetterPK == null) {
                    objectsEqual = objectsEqual && (thatLetterPK == null);
                } else {
                    objectsEqual = objectsEqual && thisLetterPK.equals(thatLetterPK);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return chainInstancePKHasBeenModified || queuedLetterSequenceHasBeenModified || letterPKHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        chainInstancePKHasBeenModified = false;
        queuedLetterSequenceHasBeenModified = false;
        letterPKHasBeenModified = false;
    }
    
    @Nonnull
    public ChainInstancePK getChainInstancePK() {
        return chainInstancePK;
    }
    
    public void setChainInstancePK(@Nonnull ChainInstancePK chainInstancePK)
            throws PersistenceNotNullException {
        checkForNull(chainInstancePK);
        
        boolean update = true;
        
        if(this.chainInstancePK != null) {
            if(this.chainInstancePK.equals(chainInstancePK)) {
                update = false;
            }
        } else if(chainInstancePK == null) {
            update = false;
        }
        
        if(update) {
            this.chainInstancePK = chainInstancePK;
            chainInstancePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getChainInstancePKHasBeenModified() {
        return chainInstancePKHasBeenModified;
    }
    
    @Nonnull
    public Integer getQueuedLetterSequence() {
        return queuedLetterSequence;
    }
    
    public void setQueuedLetterSequence(@Nonnull Integer queuedLetterSequence)
            throws PersistenceNotNullException {
        checkForNull(queuedLetterSequence);
        
        boolean update = true;
        
        if(this.queuedLetterSequence != null) {
            if(this.queuedLetterSequence.equals(queuedLetterSequence)) {
                update = false;
            }
        } else if(queuedLetterSequence == null) {
            update = false;
        }
        
        if(update) {
            this.queuedLetterSequence = queuedLetterSequence;
            queuedLetterSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getQueuedLetterSequenceHasBeenModified() {
        return queuedLetterSequenceHasBeenModified;
    }
    
    @Nonnull
    public LetterPK getLetterPK() {
        return letterPK;
    }
    
    public void setLetterPK(@Nonnull LetterPK letterPK)
            throws PersistenceNotNullException {
        checkForNull(letterPK);
        
        boolean update = true;
        
        if(this.letterPK != null) {
            if(this.letterPK.equals(letterPK)) {
                update = false;
            }
        } else if(letterPK == null) {
            update = false;
        }
        
        if(update) {
            this.letterPK = letterPK;
            letterPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getLetterPKHasBeenModified() {
        return letterPKHasBeenModified;
    }
    
}