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

/**
 * InventoryLocationBucketValue.java
 */

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

import com.echothree.model.data.inventory.common.pk.InventoryLocationBucketPK;

import com.echothree.model.data.inventory.server.factory.InventoryLocationBucketFactory;

import com.echothree.model.data.inventory.common.pk.InventoryLocationPK;
import com.echothree.model.data.inventory.common.pk.InventoryBucketTypePK;

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 InventoryLocationBucketValue
        extends BaseValue<InventoryLocationBucketPK>
        implements Cloneable, Serializable {
    
    private InventoryLocationPK inventoryLocationPK;
    private boolean inventoryLocationPKHasBeenModified = false;
    private InventoryBucketTypePK inventoryBucketTypePK;
    private boolean inventoryBucketTypePKHasBeenModified = false;
    private Long quantity;
    private boolean quantityHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(InventoryLocationPK inventoryLocationPK, InventoryBucketTypePK inventoryBucketTypePK, Long quantity)
            throws PersistenceNotNullException {
        checkForNull(inventoryLocationPK);
        this.inventoryLocationPK = inventoryLocationPK;
        checkForNull(inventoryBucketTypePK);
        this.inventoryBucketTypePK = inventoryBucketTypePK;
        checkForNull(quantity);
        this.quantity = quantity;
    }
    
    /** Creates a new instance of InventoryLocationBucketValue */
    public InventoryLocationBucketValue(InventoryLocationBucketPK inventoryLocationBucketPK, InventoryLocationPK inventoryLocationPK, InventoryBucketTypePK inventoryBucketTypePK, Long quantity)
            throws PersistenceNotNullException {
        super(inventoryLocationBucketPK);
        constructFields(inventoryLocationPK, inventoryBucketTypePK, quantity);
    }
    
    /** Creates a new instance of InventoryLocationBucketValue */
    public InventoryLocationBucketValue(InventoryLocationPK inventoryLocationPK, InventoryBucketTypePK inventoryBucketTypePK, Long quantity)
            throws PersistenceNotNullException {
        super();
        constructFields(inventoryLocationPK, inventoryBucketTypePK, quantity);
    }
    
    @Override
    @Nonnull
    public InventoryLocationBucketFactory getBaseFactoryInstance() {
        return InventoryLocationBucketFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public InventoryLocationBucketValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (InventoryLocationBucketValue)result;
    }
    
    @Override
    @Nonnull
    public InventoryLocationBucketPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new InventoryLocationBucketPK(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 + ((inventoryLocationPK != null) ? inventoryLocationPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((inventoryBucketTypePK != null) ? inventoryBucketTypePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((quantity != null) ? quantity.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", inventoryLocationPK=" + getInventoryLocationPK() +
                    ", inventoryBucketTypePK=" + getInventoryBucketTypePK() +
                    ", quantity=" + getQuantity() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  InventoryLocationBucketValue 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 InventoryLocationBucketValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                InventoryLocationPK thisInventoryLocationPK = getInventoryLocationPK();
                InventoryLocationPK thatInventoryLocationPK = that.getInventoryLocationPK();
                
                if(thisInventoryLocationPK == null) {
                    objectsEqual = objectsEqual && (thatInventoryLocationPK == null);
                } else {
                    objectsEqual = objectsEqual && thisInventoryLocationPK.equals(thatInventoryLocationPK);
                }
            }
            
            if(objectsEqual) {
                InventoryBucketTypePK thisInventoryBucketTypePK = getInventoryBucketTypePK();
                InventoryBucketTypePK thatInventoryBucketTypePK = that.getInventoryBucketTypePK();
                
                if(thisInventoryBucketTypePK == null) {
                    objectsEqual = objectsEqual && (thatInventoryBucketTypePK == null);
                } else {
                    objectsEqual = objectsEqual && thisInventoryBucketTypePK.equals(thatInventoryBucketTypePK);
                }
            }
            
            if(objectsEqual) {
                Long thisQuantity = getQuantity();
                Long thatQuantity = that.getQuantity();
                
                if(thisQuantity == null) {
                    objectsEqual = objectsEqual && (thatQuantity == null);
                } else {
                    objectsEqual = objectsEqual && thisQuantity.equals(thatQuantity);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return inventoryLocationPKHasBeenModified || inventoryBucketTypePKHasBeenModified || quantityHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        inventoryLocationPKHasBeenModified = false;
        inventoryBucketTypePKHasBeenModified = false;
        quantityHasBeenModified = false;
    }
    
    @Nonnull
    public InventoryLocationPK getInventoryLocationPK() {
        return inventoryLocationPK;
    }
    
    public void setInventoryLocationPK(@Nonnull InventoryLocationPK inventoryLocationPK)
            throws PersistenceNotNullException {
        checkForNull(inventoryLocationPK);
        
        boolean update = true;
        
        if(this.inventoryLocationPK != null) {
            if(this.inventoryLocationPK.equals(inventoryLocationPK)) {
                update = false;
            }
        } else if(inventoryLocationPK == null) {
            update = false;
        }
        
        if(update) {
            this.inventoryLocationPK = inventoryLocationPK;
            inventoryLocationPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getInventoryLocationPKHasBeenModified() {
        return inventoryLocationPKHasBeenModified;
    }
    
    @Nonnull
    public InventoryBucketTypePK getInventoryBucketTypePK() {
        return inventoryBucketTypePK;
    }
    
    public void setInventoryBucketTypePK(@Nonnull InventoryBucketTypePK inventoryBucketTypePK)
            throws PersistenceNotNullException {
        checkForNull(inventoryBucketTypePK);
        
        boolean update = true;
        
        if(this.inventoryBucketTypePK != null) {
            if(this.inventoryBucketTypePK.equals(inventoryBucketTypePK)) {
                update = false;
            }
        } else if(inventoryBucketTypePK == null) {
            update = false;
        }
        
        if(update) {
            this.inventoryBucketTypePK = inventoryBucketTypePK;
            inventoryBucketTypePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getInventoryBucketTypePKHasBeenModified() {
        return inventoryBucketTypePKHasBeenModified;
    }
    
    @Nonnull
    public Long getQuantity() {
        return quantity;
    }
    
    public void setQuantity(@Nonnull Long quantity)
            throws PersistenceNotNullException {
        checkForNull(quantity);
        
        boolean update = true;
        
        if(this.quantity != null) {
            if(this.quantity.equals(quantity)) {
                update = false;
            }
        } else if(quantity == null) {
            update = false;
        }
        
        if(update) {
            this.quantity = quantity;
            quantityHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getQuantityHasBeenModified() {
        return quantityHasBeenModified;
    }
    
}