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

/**
 * ShipmentPackageStatusValue.java
 */

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

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

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

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

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 ShipmentPackageStatusValue
        extends BaseValue<ShipmentPackageStatusPK>
        implements Cloneable, Serializable {
    
    private ShipmentPackagePK shipmentPackagePK;
    private boolean shipmentPackagePKHasBeenModified = false;
    private Integer shipmentPackageLineSequence;
    private boolean shipmentPackageLineSequenceHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(ShipmentPackagePK shipmentPackagePK, Integer shipmentPackageLineSequence)
            throws PersistenceNotNullException {
        checkForNull(shipmentPackagePK);
        this.shipmentPackagePK = shipmentPackagePK;
        checkForNull(shipmentPackageLineSequence);
        this.shipmentPackageLineSequence = shipmentPackageLineSequence;
    }
    
    /** Creates a new instance of ShipmentPackageStatusValue */
    public ShipmentPackageStatusValue(ShipmentPackageStatusPK shipmentPackageStatusPK, ShipmentPackagePK shipmentPackagePK, Integer shipmentPackageLineSequence)
            throws PersistenceNotNullException {
        super(shipmentPackageStatusPK);
        constructFields(shipmentPackagePK, shipmentPackageLineSequence);
    }
    
    /** Creates a new instance of ShipmentPackageStatusValue */
    public ShipmentPackageStatusValue(ShipmentPackagePK shipmentPackagePK, Integer shipmentPackageLineSequence)
            throws PersistenceNotNullException {
        super();
        constructFields(shipmentPackagePK, shipmentPackageLineSequence);
    }
    
    @Override
    @Nonnull
    public ShipmentPackageStatusFactory getBaseFactoryInstance() {
        return ShipmentPackageStatusFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public ShipmentPackageStatusValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (ShipmentPackageStatusValue)result;
    }
    
    @Override
    @Nonnull
    public ShipmentPackageStatusPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new ShipmentPackageStatusPK(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 + ((shipmentPackagePK != null) ? shipmentPackagePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((shipmentPackageLineSequence != null) ? shipmentPackageLineSequence.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", shipmentPackagePK=" + getShipmentPackagePK() +
                    ", shipmentPackageLineSequence=" + getShipmentPackageLineSequence() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  ShipmentPackageStatusValue 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 ShipmentPackageStatusValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                ShipmentPackagePK thisShipmentPackagePK = getShipmentPackagePK();
                ShipmentPackagePK thatShipmentPackagePK = that.getShipmentPackagePK();
                
                if(thisShipmentPackagePK == null) {
                    objectsEqual = objectsEqual && (thatShipmentPackagePK == null);
                } else {
                    objectsEqual = objectsEqual && thisShipmentPackagePK.equals(thatShipmentPackagePK);
                }
            }
            
            if(objectsEqual) {
                Integer thisShipmentPackageLineSequence = getShipmentPackageLineSequence();
                Integer thatShipmentPackageLineSequence = that.getShipmentPackageLineSequence();
                
                if(thisShipmentPackageLineSequence == null) {
                    objectsEqual = objectsEqual && (thatShipmentPackageLineSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisShipmentPackageLineSequence.equals(thatShipmentPackageLineSequence);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return shipmentPackagePKHasBeenModified || shipmentPackageLineSequenceHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        shipmentPackagePKHasBeenModified = false;
        shipmentPackageLineSequenceHasBeenModified = false;
    }
    
    @Nonnull
    public ShipmentPackagePK getShipmentPackagePK() {
        return shipmentPackagePK;
    }
    
    public void setShipmentPackagePK(@Nonnull ShipmentPackagePK shipmentPackagePK)
            throws PersistenceNotNullException {
        checkForNull(shipmentPackagePK);
        
        boolean update = true;
        
        if(this.shipmentPackagePK != null) {
            if(this.shipmentPackagePK.equals(shipmentPackagePK)) {
                update = false;
            }
        } else if(shipmentPackagePK == null) {
            update = false;
        }
        
        if(update) {
            this.shipmentPackagePK = shipmentPackagePK;
            shipmentPackagePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getShipmentPackagePKHasBeenModified() {
        return shipmentPackagePKHasBeenModified;
    }
    
    @Nonnull
    public Integer getShipmentPackageLineSequence() {
        return shipmentPackageLineSequence;
    }
    
    public void setShipmentPackageLineSequence(@Nonnull Integer shipmentPackageLineSequence)
            throws PersistenceNotNullException {
        checkForNull(shipmentPackageLineSequence);
        
        boolean update = true;
        
        if(this.shipmentPackageLineSequence != null) {
            if(this.shipmentPackageLineSequence.equals(shipmentPackageLineSequence)) {
                update = false;
            }
        } else if(shipmentPackageLineSequence == null) {
            update = false;
        }
        
        if(update) {
            this.shipmentPackageLineSequence = shipmentPackageLineSequence;
            shipmentPackageLineSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getShipmentPackageLineSequenceHasBeenModified() {
        return shipmentPackageLineSequenceHasBeenModified;
    }
    
}