com.adobe.cq.commerce.common.collection

Class AbstractProductCollection

java.lang.Object

com.adobe.cq.commerce.common.collection.AbstractProductCollection

All Implemented Interfaces:

ProductCollection

@ConsumerType
public abstract class AbstractProductCollection
extends java.lang.Object
implements ProductCollection

An abstract implementation of a ProductCollection

Constructor Summary

Constructors

Constructor and Description
AbstractProductCollection(Resource resource)

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String path) Creates a new entry (product or collection) in the collection at the last position
void	checkItemType(java.lang.String path) Throws an IllegalArgumentException if the type of the resource identified by its path is not supported by the implementation.
boolean	contains(Product product) Returns true if product reference is part of the collection.
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription() Returns the description of the collection.
java.util.Iterator<java.lang.String>	getDirectReferences() Returns an iterator over product or collection paths/IDs directly referenced in the collection.
java.lang.String	getPath() Returns the path of the collection if represented in the repository.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Returns the collection properties.
<T> T	getProperty(java.lang.String key, java.lang.Class<T> type) Returns a named collection property converted to a given type.
<T> T	getProperty(java.lang.String key, T defaultValue) Returns a named collection property or a default value if the property can not be retrieved.
java.lang.String	getTitle() Returns the title of the collection.
java.lang.String	getType() Returns the type of the collection.
boolean	hasDirectReference(java.lang.String path) Returns true if the product or the collection referenced by the path/ID is directly referenced in the collection.
int	hashCode()
void	orderBefore(java.lang.String srcPath, java.lang.String destPath) Inserts the referenced product or collection srcPath into the collection entry at the position immediately before the referenced product or collection destPath.
void	remove(java.lang.String path) Removes an entry of product or collection from collection.
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> properties) Sets the collection properties.
void	setProperty(java.lang.String key, java.lang.Object value) Sets a collection property.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adobe.cq.commerce.api.collection.ProductCollection

getProducts

Constructor Detail

AbstractProductCollection

public AbstractProductCollection(Resource resource)

Method Detail

getTitle

public java.lang.String getTitle()

Description copied from interface: ProductCollection

Returns the title of the collection.

Specified by:

getTitle in interface ProductCollection

Returns:

title of the collection.

getDescription

public java.lang.String getDescription()

Description copied from interface: ProductCollection

Returns the description of the collection.

Specified by:

getDescription in interface ProductCollection

Returns:

description of the collection.

getType

public java.lang.String getType()

Description copied from interface: ProductCollection

Returns the type of the collection.

Specified by:

getType in interface ProductCollection

Returns:

type of the collection.

getPath

public java.lang.String getPath()

Description copied from interface: ProductCollection

Returns the path of the collection if represented in the repository. Otherwise, it returns an ID uniquely identifying the collection to the external commerce engine.

Specified by:

getPath in interface ProductCollection

Returns:

path/ID of the collection.

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Description copied from interface: ProductCollection

Returns the collection properties.

Specified by:

getProperties in interface ProductCollection

Returns:

The collection properties as an unmodifiable Map.

getProperty

public <T> T getProperty(java.lang.String key,
                         java.lang.Class<T> type)

Description copied from interface: ProductCollection

Returns a named collection property converted to a given type.

Specified by:

getProperty in interface ProductCollection

Parameters:

key - The name of the property

type - The type to which the property should be converted.

Returns:

The named value converted to type T.

getProperty

public <T> T getProperty(java.lang.String key,
                         T defaultValue)

Description copied from interface: ProductCollection

Returns a named collection property or a default value if the property can not be retrieved.

Specified by:

getProperty in interface ProductCollection

Parameters:

key - The name of the property

defaultValue - The default value to use if the named property does not exist or cannot be converted to the requested type. The default value is also used to define the type to convert the value to. If this is null any existing property is not converted.

Returns:

The named value converted to type T or the default value if non existing or can't be converted.

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
                   throws CommerceException

Description copied from interface: ProductCollection

Sets the collection properties. New properties are added, existing ones are replaced.

Specified by:

setProperties in interface ProductCollection

Parameters:

properties - The new collection properties.

Throws:

CommerceException - if setting the properties fails.

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)
                 throws CommerceException

Description copied from interface: ProductCollection

Sets a collection property.

Specified by:

setProperty in interface ProductCollection

Parameters:

key - The name of the property

value - The value of the property

Throws:

CommerceException - if setting the properties fails.

contains

public boolean contains(Product product)

Description copied from interface: ProductCollection

Returns true if product reference is part of the collection.

Specified by:

contains in interface ProductCollection

Parameters:

product - product to be checked

Returns:

true if product is part of the collection. false otherwise

getDirectReferences

public java.util.Iterator<java.lang.String> getDirectReferences()

Description copied from interface: ProductCollection

Returns an iterator over product or collection paths/IDs directly referenced in the collection. These are the first level descendants of the collection as opposed to all levels descendant products returned by ProductCollection.getProducts()

Specified by:

getDirectReferences in interface ProductCollection

Returns:

iterator over product or collection paths/IDs directly referred in collection.

hasDirectReference

public boolean hasDirectReference(java.lang.String path)

Description copied from interface: ProductCollection

Returns true if the product or the collection referenced by the path/ID is directly referenced in the collection. To check if a product is part of all levels descendants of the collection, use ProductCollection.contains(com.adobe.cq.commerce.api.Product).

Specified by:

hasDirectReference in interface ProductCollection

Parameters:

path - product or collection path to be added, if the product/collection is represented in the repository. Otherwise, it is an ID uniquely identifying the product/collection to the external commerce engine.

Returns:

true if product or collection path is part of the collection. false otherwise

add

public void add(java.lang.String path)
         throws CommerceException

Description copied from interface: ProductCollection

Creates a new entry (product or collection) in the collection at the last position

Specified by:

add in interface ProductCollection

Parameters:

path - product or collection path to be added, if the product/collection is represented in the repository. Otherwise, it is an ID uniquely identifying the product/collection to the external commerce engine.

Throws:

CommerceException - if the operation fails, if collection already contained the product/collection or product/collection is null.

remove

public void remove(java.lang.String path)
            throws CommerceException

Description copied from interface: ProductCollection

Removes an entry of product or collection from collection.

Specified by:

remove in interface ProductCollection

Parameters:

path - product or collection path to be added, if the product/collection is represented in the repository. Otherwise, it is an ID uniquely identifying the product/collection to the external commerce engine.

Throws:

CommerceException - if the operation fails, or if product/collection reference was not removed / not present

orderBefore

public void orderBefore(java.lang.String srcPath,
                        java.lang.String destPath)

Description copied from interface: ProductCollection

Inserts the referenced product or collection srcPath into the collection entry at the position immediately before the referenced product or collection destPath. To insert the referenced product/collection into last position, destPath can be null.

Specified by:

orderBefore in interface ProductCollection

Parameters:

srcPath - Referenced product/collection path/ID that needs to be moved in the order

destPath - Referenced product/collection path/ID before which the srcPath will be placed.

checkItemType

public void checkItemType(java.lang.String path)

Throws an IllegalArgumentException if the type of the resource identified by its path is not supported by the implementation.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object