// --------------------------------------------------------------------------------
// Copyright 2002-2024 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
// --------------------------------------------------------------------------------

/**
 * PostalAddressLineDetailValue.java
 */

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

import com.echothree.model.data.contact.common.pk.PostalAddressLineDetailPK;

import com.echothree.model.data.contact.server.factory.PostalAddressLineDetailFactory;

import com.echothree.model.data.contact.common.pk.PostalAddressLinePK;
import com.echothree.model.data.contact.common.pk.PostalAddressFormatPK;

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;

public class PostalAddressLineDetailValue
        extends BaseValue<PostalAddressLineDetailPK>
        implements Cloneable, Serializable {
    
    private PostalAddressLinePK postalAddressLinePK;
    private boolean postalAddressLinePKHasBeenModified = false;
    private PostalAddressFormatPK postalAddressFormatPK;
    private boolean postalAddressFormatPKHasBeenModified = false;
    private Integer postalAddressLineSortOrder;
    private boolean postalAddressLineSortOrderHasBeenModified = false;
    private String prefix;
    private boolean prefixHasBeenModified = false;
    private Boolean alwaysIncludePrefix;
    private boolean alwaysIncludePrefixHasBeenModified = false;
    private String suffix;
    private boolean suffixHasBeenModified = false;
    private Boolean alwaysIncludeSuffix;
    private boolean alwaysIncludeSuffixHasBeenModified = false;
    private Boolean collapseIfEmpty;
    private boolean collapseIfEmptyHasBeenModified = 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(PostalAddressLinePK postalAddressLinePK, PostalAddressFormatPK postalAddressFormatPK, Integer postalAddressLineSortOrder, String prefix, Boolean alwaysIncludePrefix, String suffix, Boolean alwaysIncludeSuffix, Boolean collapseIfEmpty, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(postalAddressLinePK);
        this.postalAddressLinePK = postalAddressLinePK;
        checkForNull(postalAddressFormatPK);
        this.postalAddressFormatPK = postalAddressFormatPK;
        checkForNull(postalAddressLineSortOrder);
        this.postalAddressLineSortOrder = postalAddressLineSortOrder;
        this.prefix = prefix;
        checkForNull(alwaysIncludePrefix);
        this.alwaysIncludePrefix = alwaysIncludePrefix;
        this.suffix = suffix;
        checkForNull(alwaysIncludeSuffix);
        this.alwaysIncludeSuffix = alwaysIncludeSuffix;
        checkForNull(collapseIfEmpty);
        this.collapseIfEmpty = collapseIfEmpty;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of PostalAddressLineDetailValue */
    public PostalAddressLineDetailValue(PostalAddressLineDetailPK postalAddressLineDetailPK, PostalAddressLinePK postalAddressLinePK, PostalAddressFormatPK postalAddressFormatPK, Integer postalAddressLineSortOrder, String prefix, Boolean alwaysIncludePrefix, String suffix, Boolean alwaysIncludeSuffix, Boolean collapseIfEmpty, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(postalAddressLineDetailPK);
        constructFields(postalAddressLinePK, postalAddressFormatPK, postalAddressLineSortOrder, prefix, alwaysIncludePrefix, suffix, alwaysIncludeSuffix, collapseIfEmpty, fromTime, thruTime);
    }
    
    /** Creates a new instance of PostalAddressLineDetailValue */
    public PostalAddressLineDetailValue(PostalAddressLinePK postalAddressLinePK, PostalAddressFormatPK postalAddressFormatPK, Integer postalAddressLineSortOrder, String prefix, Boolean alwaysIncludePrefix, String suffix, Boolean alwaysIncludeSuffix, Boolean collapseIfEmpty, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(postalAddressLinePK, postalAddressFormatPK, postalAddressLineSortOrder, prefix, alwaysIncludePrefix, suffix, alwaysIncludeSuffix, collapseIfEmpty, fromTime, thruTime);
    }
    
   @Override
   public PostalAddressLineDetailFactory getBaseFactoryInstance() {
        return PostalAddressLineDetailFactory.getInstance();
    }
    
    @Override
    public PostalAddressLineDetailValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (PostalAddressLineDetailValue)result;
    }
    
   @Override
    public PostalAddressLineDetailPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new PostalAddressLineDetailPK(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 + ((postalAddressLinePK != null) ? postalAddressLinePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((postalAddressFormatPK != null) ? postalAddressFormatPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((postalAddressLineSortOrder != null) ? postalAddressLineSortOrder.hashCode() : 0);
            hashCode = 37 * hashCode + ((prefix != null) ? prefix.hashCode() : 0);
            hashCode = 37 * hashCode + ((alwaysIncludePrefix != null) ? alwaysIncludePrefix.hashCode() : 0);
            hashCode = 37 * hashCode + ((suffix != null) ? suffix.hashCode() : 0);
            hashCode = 37 * hashCode + ((alwaysIncludeSuffix != null) ? alwaysIncludeSuffix.hashCode() : 0);
            hashCode = 37 * hashCode + ((collapseIfEmpty != null) ? collapseIfEmpty.hashCode() : 0);
            hashCode = 37 * hashCode + ((fromTime != null) ? fromTime.hashCode() : 0);
            hashCode = 37 * hashCode + ((thruTime != null) ? thruTime.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    public String toString() {
        if(_stringValue == null) {
            StringBuilder stringValue = new StringBuilder("{");
            
            stringValue.append("entityId=").append(getEntityId());
            
            stringValue.append(", postalAddressLinePK=").append(getPostalAddressLinePK());
            stringValue.append(", postalAddressFormatPK=").append(getPostalAddressFormatPK());
            stringValue.append(", postalAddressLineSortOrder=").append(getPostalAddressLineSortOrder());
            stringValue.append(", prefix=").append(getPrefix());
            stringValue.append(", alwaysIncludePrefix=").append(getAlwaysIncludePrefix());
            stringValue.append(", suffix=").append(getSuffix());
            stringValue.append(", alwaysIncludeSuffix=").append(getAlwaysIncludeSuffix());
            stringValue.append(", collapseIfEmpty=").append(getCollapseIfEmpty());
            stringValue.append(", fromTime=").append(getFromTime());
            stringValue.append(", thruTime=").append(getThruTime());
            
            stringValue.append('}');
            
            _stringValue = stringValue.toString();
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  PostalAddressLineDetailValue) {
            PostalAddressLineDetailValue that = (PostalAddressLineDetailValue)other;
            
            if(!that.hasIdentity())
                return false;
            
            Long thisEntityId = getEntityId();
            Long thatEntityId = that.getEntityId();
            
            boolean objectsEqual = thisEntityId.equals(thatEntityId);
            if(objectsEqual)
                objectsEqual = objectsEqual && isIdentical(that);
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    public boolean isIdentical(Object other) {
        if(other instanceof PostalAddressLineDetailValue) {
            PostalAddressLineDetailValue that = (PostalAddressLineDetailValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                PostalAddressLinePK thisPostalAddressLinePK = getPostalAddressLinePK();
                PostalAddressLinePK thatPostalAddressLinePK = that.getPostalAddressLinePK();
                
                if(thisPostalAddressLinePK == null) {
                    objectsEqual = objectsEqual && (thatPostalAddressLinePK == null);
                } else {
                    objectsEqual = objectsEqual && thisPostalAddressLinePK.equals(thatPostalAddressLinePK);
                }
            }
            
            if(objectsEqual) {
                PostalAddressFormatPK thisPostalAddressFormatPK = getPostalAddressFormatPK();
                PostalAddressFormatPK thatPostalAddressFormatPK = that.getPostalAddressFormatPK();
                
                if(thisPostalAddressFormatPK == null) {
                    objectsEqual = objectsEqual && (thatPostalAddressFormatPK == null);
                } else {
                    objectsEqual = objectsEqual && thisPostalAddressFormatPK.equals(thatPostalAddressFormatPK);
                }
            }
            
            if(objectsEqual) {
                Integer thisPostalAddressLineSortOrder = getPostalAddressLineSortOrder();
                Integer thatPostalAddressLineSortOrder = that.getPostalAddressLineSortOrder();
                
                if(thisPostalAddressLineSortOrder == null) {
                    objectsEqual = objectsEqual && (thatPostalAddressLineSortOrder == null);
                } else {
                    objectsEqual = objectsEqual && thisPostalAddressLineSortOrder.equals(thatPostalAddressLineSortOrder);
                }
            }
            
            if(objectsEqual) {
                String thisPrefix = getPrefix();
                String thatPrefix = that.getPrefix();
                
                if(thisPrefix == null) {
                    objectsEqual = objectsEqual && (thatPrefix == null);
                } else {
                    objectsEqual = objectsEqual && thisPrefix.equals(thatPrefix);
                }
            }
            
            if(objectsEqual) {
                Boolean thisAlwaysIncludePrefix = getAlwaysIncludePrefix();
                Boolean thatAlwaysIncludePrefix = that.getAlwaysIncludePrefix();
                
                if(thisAlwaysIncludePrefix == null) {
                    objectsEqual = objectsEqual && (thatAlwaysIncludePrefix == null);
                } else {
                    objectsEqual = objectsEqual && thisAlwaysIncludePrefix.equals(thatAlwaysIncludePrefix);
                }
            }
            
            if(objectsEqual) {
                String thisSuffix = getSuffix();
                String thatSuffix = that.getSuffix();
                
                if(thisSuffix == null) {
                    objectsEqual = objectsEqual && (thatSuffix == null);
                } else {
                    objectsEqual = objectsEqual && thisSuffix.equals(thatSuffix);
                }
            }
            
            if(objectsEqual) {
                Boolean thisAlwaysIncludeSuffix = getAlwaysIncludeSuffix();
                Boolean thatAlwaysIncludeSuffix = that.getAlwaysIncludeSuffix();
                
                if(thisAlwaysIncludeSuffix == null) {
                    objectsEqual = objectsEqual && (thatAlwaysIncludeSuffix == null);
                } else {
                    objectsEqual = objectsEqual && thisAlwaysIncludeSuffix.equals(thatAlwaysIncludeSuffix);
                }
            }
            
            if(objectsEqual) {
                Boolean thisCollapseIfEmpty = getCollapseIfEmpty();
                Boolean thatCollapseIfEmpty = that.getCollapseIfEmpty();
                
                if(thisCollapseIfEmpty == null) {
                    objectsEqual = objectsEqual && (thatCollapseIfEmpty == null);
                } else {
                    objectsEqual = objectsEqual && thisCollapseIfEmpty.equals(thatCollapseIfEmpty);
                }
            }
            
            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 postalAddressLinePKHasBeenModified || postalAddressFormatPKHasBeenModified || postalAddressLineSortOrderHasBeenModified || prefixHasBeenModified || alwaysIncludePrefixHasBeenModified || suffixHasBeenModified || alwaysIncludeSuffixHasBeenModified || collapseIfEmptyHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        postalAddressLinePKHasBeenModified = false;
        postalAddressFormatPKHasBeenModified = false;
        postalAddressLineSortOrderHasBeenModified = false;
        prefixHasBeenModified = false;
        alwaysIncludePrefixHasBeenModified = false;
        suffixHasBeenModified = false;
        alwaysIncludeSuffixHasBeenModified = false;
        collapseIfEmptyHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    public PostalAddressLinePK getPostalAddressLinePK() {
        return postalAddressLinePK;
    }
    
    public void setPostalAddressLinePK(PostalAddressLinePK postalAddressLinePK)
            throws PersistenceNotNullException {
        checkForNull(postalAddressLinePK);
        
        boolean update = true;
        
        if(this.postalAddressLinePK != null) {
            if(this.postalAddressLinePK.equals(postalAddressLinePK)) {
                update = false;
            }
        } else if(postalAddressLinePK == null) {
            update = false;
        }
        
        if(update) {
            this.postalAddressLinePK = postalAddressLinePK;
            postalAddressLinePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPostalAddressLinePKHasBeenModified() {
        return postalAddressLinePKHasBeenModified;
    }
    
    public PostalAddressFormatPK getPostalAddressFormatPK() {
        return postalAddressFormatPK;
    }
    
    public void setPostalAddressFormatPK(PostalAddressFormatPK postalAddressFormatPK)
            throws PersistenceNotNullException {
        checkForNull(postalAddressFormatPK);
        
        boolean update = true;
        
        if(this.postalAddressFormatPK != null) {
            if(this.postalAddressFormatPK.equals(postalAddressFormatPK)) {
                update = false;
            }
        } else if(postalAddressFormatPK == null) {
            update = false;
        }
        
        if(update) {
            this.postalAddressFormatPK = postalAddressFormatPK;
            postalAddressFormatPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPostalAddressFormatPKHasBeenModified() {
        return postalAddressFormatPKHasBeenModified;
    }
    
    public Integer getPostalAddressLineSortOrder() {
        return postalAddressLineSortOrder;
    }
    
    public void setPostalAddressLineSortOrder(Integer postalAddressLineSortOrder)
            throws PersistenceNotNullException {
        checkForNull(postalAddressLineSortOrder);
        
        boolean update = true;
        
        if(this.postalAddressLineSortOrder != null) {
            if(this.postalAddressLineSortOrder.equals(postalAddressLineSortOrder)) {
                update = false;
            }
        } else if(postalAddressLineSortOrder == null) {
            update = false;
        }
        
        if(update) {
            this.postalAddressLineSortOrder = postalAddressLineSortOrder;
            postalAddressLineSortOrderHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPostalAddressLineSortOrderHasBeenModified() {
        return postalAddressLineSortOrderHasBeenModified;
    }
    
    public String getPrefix() {
        return prefix;
    }
    
    public void setPrefix(String prefix) {
        boolean update = true;
        
        if(this.prefix != null) {
            if(this.prefix.equals(prefix)) {
                update = false;
            }
        } else if(prefix == null) {
            update = false;
        }
        
        if(update) {
            this.prefix = prefix;
            prefixHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPrefixHasBeenModified() {
        return prefixHasBeenModified;
    }
    
    public Boolean getAlwaysIncludePrefix() {
        return alwaysIncludePrefix;
    }
    
    public void setAlwaysIncludePrefix(Boolean alwaysIncludePrefix)
            throws PersistenceNotNullException {
        checkForNull(alwaysIncludePrefix);
        
        boolean update = true;
        
        if(this.alwaysIncludePrefix != null) {
            if(this.alwaysIncludePrefix.equals(alwaysIncludePrefix)) {
                update = false;
            }
        } else if(alwaysIncludePrefix == null) {
            update = false;
        }
        
        if(update) {
            this.alwaysIncludePrefix = alwaysIncludePrefix;
            alwaysIncludePrefixHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getAlwaysIncludePrefixHasBeenModified() {
        return alwaysIncludePrefixHasBeenModified;
    }
    
    public String getSuffix() {
        return suffix;
    }
    
    public void setSuffix(String suffix) {
        boolean update = true;
        
        if(this.suffix != null) {
            if(this.suffix.equals(suffix)) {
                update = false;
            }
        } else if(suffix == null) {
            update = false;
        }
        
        if(update) {
            this.suffix = suffix;
            suffixHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getSuffixHasBeenModified() {
        return suffixHasBeenModified;
    }
    
    public Boolean getAlwaysIncludeSuffix() {
        return alwaysIncludeSuffix;
    }
    
    public void setAlwaysIncludeSuffix(Boolean alwaysIncludeSuffix)
            throws PersistenceNotNullException {
        checkForNull(alwaysIncludeSuffix);
        
        boolean update = true;
        
        if(this.alwaysIncludeSuffix != null) {
            if(this.alwaysIncludeSuffix.equals(alwaysIncludeSuffix)) {
                update = false;
            }
        } else if(alwaysIncludeSuffix == null) {
            update = false;
        }
        
        if(update) {
            this.alwaysIncludeSuffix = alwaysIncludeSuffix;
            alwaysIncludeSuffixHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getAlwaysIncludeSuffixHasBeenModified() {
        return alwaysIncludeSuffixHasBeenModified;
    }
    
    public Boolean getCollapseIfEmpty() {
        return collapseIfEmpty;
    }
    
    public void setCollapseIfEmpty(Boolean collapseIfEmpty)
            throws PersistenceNotNullException {
        checkForNull(collapseIfEmpty);
        
        boolean update = true;
        
        if(this.collapseIfEmpty != null) {
            if(this.collapseIfEmpty.equals(collapseIfEmpty)) {
                update = false;
            }
        } else if(collapseIfEmpty == null) {
            update = false;
        }
        
        if(update) {
            this.collapseIfEmpty = collapseIfEmpty;
            collapseIfEmptyHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getCollapseIfEmptyHasBeenModified() {
        return collapseIfEmptyHasBeenModified;
    }
    
    public Long getFromTime() {
        return fromTime;
    }
    
    public void setFromTime(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;
    }
    
    public Long getThruTime() {
        return thruTime;
    }
    
    public void setThruTime(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;
    }
    
}