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

/**
 * ShipmentStatusValue.java
 */

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

import com.echothree.model.data.shipment.common.pk.ShipmentStatusPK;

import com.echothree.model.data.shipment.server.factory.ShipmentStatusFactory;

import com.echothree.model.data.shipment.common.pk.ShipmentPK;

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 ShipmentStatusValue
        extends BaseValue<ShipmentStatusPK>
        implements Cloneable, Serializable {
    
    private ShipmentPK shipmentPK;
    private boolean shipmentPKHasBeenModified = false;
    private Integer shipmentLineSequence;
    private boolean shipmentLineSequenceHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(ShipmentPK shipmentPK, Integer shipmentLineSequence)
            throws PersistenceNotNullException {
        checkForNull(shipmentPK);
        this.shipmentPK = shipmentPK;
        checkForNull(shipmentLineSequence);
        this.shipmentLineSequence = shipmentLineSequence;
    }
    
    /** Creates a new instance of ShipmentStatusValue */
    public ShipmentStatusValue(ShipmentStatusPK shipmentStatusPK, ShipmentPK shipmentPK, Integer shipmentLineSequence)
            throws PersistenceNotNullException {
        super(shipmentStatusPK);
        constructFields(shipmentPK, shipmentLineSequence);
    }
    
    /** Creates a new instance of ShipmentStatusValue */
    public ShipmentStatusValue(ShipmentPK shipmentPK, Integer shipmentLineSequence)
            throws PersistenceNotNullException {
        super();
        constructFields(shipmentPK, shipmentLineSequence);
    }
    
    @Override
    @Nonnull
    public ShipmentStatusFactory getBaseFactoryInstance() {
        return ShipmentStatusFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public ShipmentStatusValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (ShipmentStatusValue)result;
    }
    
    @Override
    @Nonnull
    public ShipmentStatusPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new ShipmentStatusPK(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 + ((shipmentPK != null) ? shipmentPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((shipmentLineSequence != null) ? shipmentLineSequence.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", shipmentPK=" + getShipmentPK() +
                    ", shipmentLineSequence=" + getShipmentLineSequence() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  ShipmentStatusValue 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 ShipmentStatusValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                ShipmentPK thisShipmentPK = getShipmentPK();
                ShipmentPK thatShipmentPK = that.getShipmentPK();
                
                if(thisShipmentPK == null) {
                    objectsEqual = objectsEqual && (thatShipmentPK == null);
                } else {
                    objectsEqual = objectsEqual && thisShipmentPK.equals(thatShipmentPK);
                }
            }
            
            if(objectsEqual) {
                Integer thisShipmentLineSequence = getShipmentLineSequence();
                Integer thatShipmentLineSequence = that.getShipmentLineSequence();
                
                if(thisShipmentLineSequence == null) {
                    objectsEqual = objectsEqual && (thatShipmentLineSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisShipmentLineSequence.equals(thatShipmentLineSequence);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return shipmentPKHasBeenModified || shipmentLineSequenceHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        shipmentPKHasBeenModified = false;
        shipmentLineSequenceHasBeenModified = false;
    }
    
    @Nonnull
    public ShipmentPK getShipmentPK() {
        return shipmentPK;
    }
    
    public void setShipmentPK(@Nonnull ShipmentPK shipmentPK)
            throws PersistenceNotNullException {
        checkForNull(shipmentPK);
        
        boolean update = true;
        
        if(this.shipmentPK != null) {
            if(this.shipmentPK.equals(shipmentPK)) {
                update = false;
            }
        } else if(shipmentPK == null) {
            update = false;
        }
        
        if(update) {
            this.shipmentPK = shipmentPK;
            shipmentPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getShipmentPKHasBeenModified() {
        return shipmentPKHasBeenModified;
    }
    
    @Nonnull
    public Integer getShipmentLineSequence() {
        return shipmentLineSequence;
    }
    
    public void setShipmentLineSequence(@Nonnull Integer shipmentLineSequence)
            throws PersistenceNotNullException {
        checkForNull(shipmentLineSequence);
        
        boolean update = true;
        
        if(this.shipmentLineSequence != null) {
            if(this.shipmentLineSequence.equals(shipmentLineSequence)) {
                update = false;
            }
        } else if(shipmentLineSequence == null) {
            update = false;
        }
        
        if(update) {
            this.shipmentLineSequence = shipmentLineSequence;
            shipmentLineSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getShipmentLineSequenceHasBeenModified() {
        return shipmentLineSequenceHasBeenModified;
    }
    
}