com.elasticpath.xpf.connectivity.entity

Class XPFEntity

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

Direct Known Subclasses:

XPFAddress, XPFAgreement, XPFAttribute, XPFAttributeValue, XPFBasePriceSource, XPFBasePriceTier, XPFBrand, XPFBundleConstituent, XPFCartItemShopperEventContext, XPFCartPromotionsCalculatorInputContext, XPFCartType, XPFCatalog, XPFCatalogPromotionsCalculatorInputContext, XPFCategory, XPFContact, XPFContainerPricing, XPFCoupon, XPFCouponUsageValidationResult, XPFCustomer, XPFCustomerEventContext, XPFCustomerTagSetContext, XPFDeleteTaxDocumentContext, XPFDeliveryPolicy, XPFExtensionInitializationContext, XPFFindAllBasePriceSourcesContext, XPFFindBasePricesContext, XPFFindShopperBasePriceSourcesContext, XPFHttpCookie, XPFHttpServletRequest, XPFHttpSession, XPFHttpTagSetContext, XPFInventory, XPFInventoryExecutionResult, XPFInventoryKeyContext, XPFInventoryKeySetContext, XPFItemPricing, XPFLinePricing, XPFModifierField, XPFModifierFieldOption, XPFModifierGroup, XPFNotificationDeliveryContext, XPFNotificationRecipient, XPFOpenIdClaims, XPFOpenIdClaimsExtractionContext, XPFOpenIdClaimsExtractionResult, XPFOpenIDCMUserAccess, XPFOpenIdCMUserClaimsExtractionResult, XPFOrder, XPFOrderDataPopulatorContext, XPFOrderHold, XPFOrderHoldStrategyContext, XPFOrderItem, XPFOrderPaymentInstrument, XPFOrderReleaseEventContext, XPFOrderReturn, XPFOrderShipment, XPFPaginatedContext, XPFPaginatedResults, XPFPayment, XPFPaymentInstrument, XPFPaymentProviderConfiguration, XPFPaymentSchedule, XPFPluginInitializationContext, XPFPluginSetting, XPFPluginSettingValue, XPFPrice, XPFPricePeriod, XPFProduct, XPFProductEventContext, XPFProductRecommendation, XPFProductSku, XPFProductSkuOption, XPFProductSkuOptionValue, XPFProductSkuValidationContext, XPFProductType, XPFPromotionAction, XPFPromotionCalculatorCouponCodeRetrievalContext, XPFPromotionCalculatorCouponCreationContext, XPFPromotionCalculatorCouponGuidRetrievalContext, XPFPromotionCalculatorCouponStoreEmailRetrievalContext, XPFPromotionCalculatorCouponValidationContext, XPFPromotionCalculatorDisableCouponContext, XPFPromotionCalculatorTriggerActionsAtCheckoutContext, XPFPromotionCarrotsInputContext, XPFPromotionCouponValidationOutputContext, XPFPromotionElement, XPFPromotionElementGroup, XPFPromotionRule, XPFPromotionsCalculatorOutputContext, XPFPromotionsCalculatorRuleRetrievalContext, XPFRecurringPricing, XPFSession, XPFSettingValue, XPFSettingValueRetrievalContext, XPFShippingInfo, XPFShippingOption, XPFShopper, XPFShoppingCart, XPFShoppingCartEventContext, XPFShoppingCartValidationContext, XPFShoppingItem, XPFShoppingItemValidationContext, XPFStore, XPFTaxableShoppingItem, XPFTaxCalculationContext, XPFTaxDocument, XPFTaxDocumentContext, XPFTaxedItem, XPFTaxedItems, XPFTaxLine, XPFTaxOverride, XPFTaxRecord, XPFTotalTaxLine, XPFUnitOfMeasure, XPFUpdateSingleQuantityInventoryContext, XPFWarehouse

public class XPFEntity
extends Object

Base XPF Entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFEntity.XPFEntityBuilder<C extends XPFEntity,B extends XPFEntity.XPFEntityBuilder<C,B>>

Constructor Summary

Constructors

Modifier	Constructor and Description
	XPFEntity() Default constructor.
	XPFEntity(Map<String,Object> customData) Constructor.
protected	XPFEntity(XPFEntity.XPFEntityBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFEntity.XPFEntityBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@NonNull Map<String,Object>	getCustomData()
<T> T	getCustomDataValue(String key, Class<T> type) Retrieves a custom data value by key and casts it to the specified type.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XPFEntity

public XPFEntity()

Default constructor.

XPFEntity

public XPFEntity(Map<String,Object> customData)

Constructor.

Parameters:

customData - custom data

XPFEntity

protected XPFEntity(XPFEntity.XPFEntityBuilder<?,?> b)

Method Detail

getCustomDataValue

public <T> T getCustomDataValue(String key,
                                Class<T> type)

Retrieves a custom data value by key and casts it to the specified type.

Type Parameters:

T - the return type

Parameters:

key - the custom data key

type - the expected type of the value

Returns:

the value cast to the specified type, or null if the key is not present or maps to null

Throws:

ClassCastException - if the value cannot be cast to the specified type

builder

public static XPFEntity.XPFEntityBuilder<?,?> builder()

getCustomData

@NonNull
public @NonNull Map<String,Object> getCustomData()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object