Package com.broadleafcommerce.promotion.offer.service.dto.comparator

Class TargetLineItemOfferDetailComparator

java.lang.Object

com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

All Implemented Interfaces:

Comparator<LineItemOfferDetail>

public class TargetLineItemOfferDetailComparator
extends Object
implements Comparator<LineItemOfferDetail>

Comparator for LineItemOfferDetails being used as targets of offers. Orders by either the standard or sale price of the details' LineItems.

A Comparator was used instead of LineItemOfferDetail implementing Comparable because we need a flag to determine whether to use the sale price or standard price in the comparison. See useSalePrice.

Author:

Nathan Moore (nathanmoore).

See Also:

EnhancedLineItem, LineItemOfferDetail

Constructor Summary

Constructors

Constructor	Description
TargetLineItemOfferDetailComparator()
TargetLineItemOfferDetailComparator(boolean useSalePrice, String targetGroupingStrategy)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
int	compare(LineItemOfferDetail o1, LineItemOfferDetail o2)	Orders by highest amount first.
boolean	equals(Object o)
String	getTargetGroupingStrategy()	The target grouping strategy.
int	hashCode()
boolean	isUseSalePrice()	Determines whether to compare LineItemOfferDetails using their EnhancedLineItem.getSalePrice() instead of EnhancedLineItem.getStandardPrice().
void	setTargetGroupingStrategy(String targetGroupingStrategy)	The target grouping strategy.
void	setUseSalePrice(boolean useSalePrice)	Determines whether to compare LineItemOfferDetails using their EnhancedLineItem.getSalePrice() instead of EnhancedLineItem.getStandardPrice().
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

TargetLineItemOfferDetailComparator

public TargetLineItemOfferDetailComparator(boolean useSalePrice,
                                           String targetGroupingStrategy)

TargetLineItemOfferDetailComparator

public TargetLineItemOfferDetailComparator()

Method Detail

compare

public int compare(LineItemOfferDetail o1,
                   LineItemOfferDetail o2)

Orders by highest amount first.

Specified by:

compare in interface Comparator<LineItemOfferDetail>

isUseSalePrice

public boolean isUseSalePrice()

Determines whether to compare LineItemOfferDetails using their EnhancedLineItem.getSalePrice() instead of EnhancedLineItem.getStandardPrice().

Returns:

whether to compare LineItemOfferDetails using their EnhancedLineItem.getSalePrice() instead of EnhancedLineItem.getStandardPrice().

getTargetGroupingStrategy

public String getTargetGroupingStrategy()

The target grouping strategy. Affects how the item comparison is performed, using either COSTLIEST (default) or CHEAPEST

See Also:

TargetGroupingStrategy

setUseSalePrice

public void setUseSalePrice(boolean useSalePrice)

Determines whether to compare LineItemOfferDetails using their EnhancedLineItem.getSalePrice() instead of EnhancedLineItem.getStandardPrice().

Parameters:

useSalePrice - whether to compare LineItemOfferDetails using their EnhancedLineItem.getSalePrice() instead of EnhancedLineItem.getStandardPrice().

setTargetGroupingStrategy

public void setTargetGroupingStrategy(String targetGroupingStrategy)

The target grouping strategy. Affects how the item comparison is performed, using either COSTLIEST (default) or CHEAPEST

See Also:

TargetGroupingStrategy

equals

public boolean equals(Object o)

Specified by:

equals in interface Comparator<LineItemOfferDetail>

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