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

/**
 * SequenceValueValue.java
 */

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

import com.echothree.model.data.sequence.common.pk.SequenceValuePK;

import com.echothree.model.data.sequence.server.factory.SequenceValueFactory;

import com.echothree.model.data.sequence.common.pk.SequencePK;

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 SequenceValueValue
        extends BaseValue<SequenceValuePK>
        implements Cloneable, Serializable {
    
    private SequencePK sequencePK;
    private boolean sequencePKHasBeenModified = false;
    private String value;
    private boolean valueHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(SequencePK sequencePK, String value)
            throws PersistenceNotNullException {
        checkForNull(sequencePK);
        this.sequencePK = sequencePK;
        checkForNull(value);
        this.value = value;
    }
    
    /** Creates a new instance of SequenceValueValue */
    public SequenceValueValue(SequenceValuePK sequenceValuePK, SequencePK sequencePK, String value)
            throws PersistenceNotNullException {
        super(sequenceValuePK);
        constructFields(sequencePK, value);
    }
    
    /** Creates a new instance of SequenceValueValue */
    public SequenceValueValue(SequencePK sequencePK, String value)
            throws PersistenceNotNullException {
        super();
        constructFields(sequencePK, value);
    }
    
    @Override
    @Nonnull
    public SequenceValueFactory getBaseFactoryInstance() {
        return SequenceValueFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public SequenceValueValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (SequenceValueValue)result;
    }
    
    @Override
    @Nonnull
    public SequenceValuePK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new SequenceValuePK(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 + ((sequencePK != null) ? sequencePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((value != null) ? value.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", sequencePK=" + getSequencePK() +
                    ", value=" + getValue() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  SequenceValueValue 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 SequenceValueValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                SequencePK thisSequencePK = getSequencePK();
                SequencePK thatSequencePK = that.getSequencePK();
                
                if(thisSequencePK == null) {
                    objectsEqual = objectsEqual && (thatSequencePK == null);
                } else {
                    objectsEqual = objectsEqual && thisSequencePK.equals(thatSequencePK);
                }
            }
            
            if(objectsEqual) {
                String thisValue = getValue();
                String thatValue = that.getValue();
                
                if(thisValue == null) {
                    objectsEqual = objectsEqual && (thatValue == null);
                } else {
                    objectsEqual = objectsEqual && thisValue.equals(thatValue);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return sequencePKHasBeenModified || valueHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        sequencePKHasBeenModified = false;
        valueHasBeenModified = false;
    }
    
    @Nonnull
    public SequencePK getSequencePK() {
        return sequencePK;
    }
    
    public void setSequencePK(@Nonnull SequencePK sequencePK)
            throws PersistenceNotNullException {
        checkForNull(sequencePK);
        
        boolean update = true;
        
        if(this.sequencePK != null) {
            if(this.sequencePK.equals(sequencePK)) {
                update = false;
            }
        } else if(sequencePK == null) {
            update = false;
        }
        
        if(update) {
            this.sequencePK = sequencePK;
            sequencePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getSequencePKHasBeenModified() {
        return sequencePKHasBeenModified;
    }
    
    @Nonnull
    public String getValue() {
        return value;
    }
    
    public void setValue(@Nonnull String value)
            throws PersistenceNotNullException {
        checkForNull(value);
        
        boolean update = true;
        
        if(this.value != null) {
            if(this.value.equals(value)) {
                update = false;
            }
        } else if(value == null) {
            update = false;
        }
        
        if(update) {
            this.value = value;
            valueHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getValueHasBeenModified() {
        return valueHasBeenModified;
    }
    
}