org.broadleafcommerce.common.extension.NativeMethodEntityExtensionHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of broadleaf-common Show documentation

A collection of classes shared by broadleaf profile, cms, admin, and core.

There is a newer version: 3.1.15-GA

/*
 * #%L
 * BroadleafCommerce Common Libraries
 * %%
 * Copyright (C) 2009 - 2014 Broadleaf Commerce
 * %%
 * 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.
 * #L%
 */
package org.broadleafcommerce.common.extension;

import org.broadleafcommerce.common.site.domain.SiteImpl;
import org.broadleafcommerce.common.web.BroadleafRequestContext;

/**
 * 
 * Extension handler used for contributions to native Object methods on entity like equals() clone() and hashCode(). It is
 * possible that dynamically weaved in columns from embeddables need to contribute to those methods.
 * 
 * 

 * Managers that implement this handler should add themselves to the {@code blEntityExtensionManagers} list:
 * 
 * 
 * {@code
 * 
 *       
 *           
 *               
 *           
 *       
 *   
 *
 *   
 *       
 *       
 *   
 * }
 * 
 * 
 * 
 * These {@link blEntityExtensionManagers} are added onto the {@link BroadleafRequestContext} with
 * {@link BroadleafRequestContext#getAdditionalProperties()}. Native methods can use that to pull it off
 * 
 * 
 * Example use case is in {@link SiteImpl#clone} as well as {@link CategoryImpl#getAllChildCategoryXrefs()}
 * 
 * @author Phillip Verheyden (phillipuniverse)
 */
public interface NativeMethodEntityExtensionHandler extends ExtensionHandler {

    /**
     * Contributes additional properties to a cloned instance. Implementors should take properties from from and
     * copy them over to to
     * 
     * @param from the original instance that is being cloned
     * @param to the instance that from is being cloned to
     */
    public void contributeClone(T from, T to);

    /**
     * Contributes additional equals() checks. Dynamically weaved properties should check between original and 
     * test and store the result in result.
     * 
     * @param original the instance being checked for equals (the 'this' side of equals)
     * @param test the instance being compared to original for equality
     * @param result where the result should be stored if this extension manager
     */
    public void contributeEquals(T original, T test, ExtensionResultHolder result);
    
    /**
     * Contributes more properties to build an object's hashCode().
     * 
     * @param entity the entity whose hashCode is being computed
     * @param precomputedHashCode the hashCode precomputed from the existing properties on entity
     * @param result where the final hashCode() should be stored
     */
    public void contributeHashCode(T entity, int precomputedHashCode, ExtensionResultHolder result);

}