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

/**
 * EntityAttributeStringValue.java
 */

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

import com.echothree.model.data.core.common.pk.EntityAttributeStringPK;

import com.echothree.model.data.core.server.factory.EntityAttributeStringFactory;

import com.echothree.model.data.core.common.pk.EntityAttributePK;

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 EntityAttributeStringValue
        extends BaseValue<EntityAttributeStringPK>
        implements Cloneable, Serializable {
    
    private EntityAttributePK entityAttributePK;
    private boolean entityAttributePKHasBeenModified = false;
    private String validationPattern;
    private boolean validationPatternHasBeenModified = false;
    private Long fromTime;
    private boolean fromTimeHasBeenModified = false;
    private Long thruTime;
    private boolean thruTimeHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(EntityAttributePK entityAttributePK, String validationPattern, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(entityAttributePK);
        this.entityAttributePK = entityAttributePK;
        this.validationPattern = validationPattern;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of EntityAttributeStringValue */
    public EntityAttributeStringValue(EntityAttributeStringPK entityAttributeStringPK, EntityAttributePK entityAttributePK, String validationPattern, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(entityAttributeStringPK);
        constructFields(entityAttributePK, validationPattern, fromTime, thruTime);
    }
    
    /** Creates a new instance of EntityAttributeStringValue */
    public EntityAttributeStringValue(EntityAttributePK entityAttributePK, String validationPattern, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(entityAttributePK, validationPattern, fromTime, thruTime);
    }
    
    @Override
    @Nonnull
    public EntityAttributeStringFactory getBaseFactoryInstance() {
        return EntityAttributeStringFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public EntityAttributeStringValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (EntityAttributeStringValue)result;
    }
    
    @Override
    @Nonnull
    public EntityAttributeStringPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new EntityAttributeStringPK(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 + ((entityAttributePK != null) ? entityAttributePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((validationPattern != null) ? validationPattern.hashCode() : 0);
            hashCode = 37 * hashCode + ((fromTime != null) ? fromTime.hashCode() : 0);
            hashCode = 37 * hashCode + ((thruTime != null) ? thruTime.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", entityAttributePK=" + getEntityAttributePK() +
                    ", validationPattern=" + getValidationPattern() +
                    ", fromTime=" + getFromTime() +
                    ", thruTime=" + getThruTime() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  EntityAttributeStringValue 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 EntityAttributeStringValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                EntityAttributePK thisEntityAttributePK = getEntityAttributePK();
                EntityAttributePK thatEntityAttributePK = that.getEntityAttributePK();
                
                if(thisEntityAttributePK == null) {
                    objectsEqual = objectsEqual && (thatEntityAttributePK == null);
                } else {
                    objectsEqual = objectsEqual && thisEntityAttributePK.equals(thatEntityAttributePK);
                }
            }
            
            if(objectsEqual) {
                String thisValidationPattern = getValidationPattern();
                String thatValidationPattern = that.getValidationPattern();
                
                if(thisValidationPattern == null) {
                    objectsEqual = objectsEqual && (thatValidationPattern == null);
                } else {
                    objectsEqual = objectsEqual && thisValidationPattern.equals(thatValidationPattern);
                }
            }
            
            if(objectsEqual) {
                Long thisFromTime = getFromTime();
                Long thatFromTime = that.getFromTime();
                
                if(thisFromTime == null) {
                    objectsEqual = objectsEqual && (thatFromTime == null);
                } else {
                    objectsEqual = objectsEqual && thisFromTime.equals(thatFromTime);
                }
            }
            
            if(objectsEqual) {
                Long thisThruTime = getThruTime();
                Long thatThruTime = that.getThruTime();
                
                if(thisThruTime == null) {
                    objectsEqual = objectsEqual && (thatThruTime == null);
                } else {
                    objectsEqual = objectsEqual && thisThruTime.equals(thatThruTime);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return entityAttributePKHasBeenModified || validationPatternHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        entityAttributePKHasBeenModified = false;
        validationPatternHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    @Nonnull
    public EntityAttributePK getEntityAttributePK() {
        return entityAttributePK;
    }
    
    public void setEntityAttributePK(@Nonnull EntityAttributePK entityAttributePK)
            throws PersistenceNotNullException {
        checkForNull(entityAttributePK);
        
        boolean update = true;
        
        if(this.entityAttributePK != null) {
            if(this.entityAttributePK.equals(entityAttributePK)) {
                update = false;
            }
        } else if(entityAttributePK == null) {
            update = false;
        }
        
        if(update) {
            this.entityAttributePK = entityAttributePK;
            entityAttributePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getEntityAttributePKHasBeenModified() {
        return entityAttributePKHasBeenModified;
    }
    
    @Nullable
    public String getValidationPattern() {
        return validationPattern;
    }
    
    public void setValidationPattern(@Nullable String validationPattern) {
        boolean update = true;
        
        if(this.validationPattern != null) {
            if(this.validationPattern.equals(validationPattern)) {
                update = false;
            }
        } else if(validationPattern == null) {
            update = false;
        }
        
        if(update) {
            this.validationPattern = validationPattern;
            validationPatternHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getValidationPatternHasBeenModified() {
        return validationPatternHasBeenModified;
    }
    
    @Nonnull
    public Long getFromTime() {
        return fromTime;
    }
    
    public void setFromTime(@Nonnull Long fromTime)
            throws PersistenceNotNullException {
        checkForNull(fromTime);
        
        boolean update = true;
        
        if(this.fromTime != null) {
            if(this.fromTime.equals(fromTime)) {
                update = false;
            }
        } else if(fromTime == null) {
            update = false;
        }
        
        if(update) {
            this.fromTime = fromTime;
            fromTimeHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getFromTimeHasBeenModified() {
        return fromTimeHasBeenModified;
    }
    
    @Nonnull
    public Long getThruTime() {
        return thruTime;
    }
    
    public void setThruTime(@Nonnull Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(thruTime);
        
        boolean update = true;
        
        if(this.thruTime != null) {
            if(this.thruTime.equals(thruTime)) {
                update = false;
            }
        } else if(thruTime == null) {
            update = false;
        }
        
        if(update) {
            this.thruTime = thruTime;
            thruTimeHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getThruTimeHasBeenModified() {
        return thruTimeHasBeenModified;
    }
    
}