org.cip4.lib.xjdf.builder

Class ProductBuilder

java.lang.Object

org.cip4.lib.xjdf.builder.AbstractNodeBuilder<Product>

org.cip4.lib.xjdf.builder.ProductBuilder

public class ProductBuilder
extends AbstractNodeBuilder<Product>

Implementation of a Product builder class.

Author:

s.meissner

Constructor Summary

Constructors

Constructor and Description
ProductBuilder() Default constructor.
ProductBuilder(Integer amount) Custom Constructor.
ProductBuilder(Integer amount, String productType, String productTypeDetails) Custom Constructor.
ProductBuilder(Integer amount, String productType, String productTypeDetails, String descriptiveName) Custom Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ProductBuilder	addChildProduct(Product product) Append another product as child.
ProductBuilder	addIntent(IntentType intent) Append Intent node to Product Definition.
protected Product	getProduct() Getter for product attribute.

Methods inherited from class org.cip4.lib.xjdf.builder.AbstractNodeBuilder

build, getNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProductBuilder

public ProductBuilder()

Default constructor.

ProductBuilder

public ProductBuilder(Integer amount)

Custom Constructor. Creates a new instance of ProductBuilder which already contains attribute Amount.

Parameters:

amount - Value of Amount attribute

ProductBuilder

public ProductBuilder(Integer amount,
              String productType,
              String productTypeDetails)

Custom Constructor. Creates a new instance of ProductBuilder which already contains attributes Amount, ID, ProductType and ProductTypeDetails.

Parameters:

amount - Value of Amount attribute

productType - Value of ProductType attribute

productTypeDetails - Value of ProductTypeDetails attribute

ProductBuilder

public ProductBuilder(Integer amount,
              String productType,
              String productTypeDetails,
              String descriptiveName)

Custom Constructor. Creates a new instance of ProductBuilder which already contains attributes Amount, ID, ProductType and ProductTypeDetails.

Parameters:

amount - Value of Amount attribute

id - Value of ID attribute

productType - Value of ProductType attribute

productTypeDetails - Value of ProductTypeDetails attribute

descriptiveName - String value for DescriptiveName attribute.

Method Detail

getProduct

protected Product getProduct()

Getter for product attribute.

Returns:

the product

addIntent

public ProductBuilder addIntent(IntentType intent)

Append Intent node to Product Definition.

Parameters:

intent - Intent object to append to.

Returns:

The current ProductBuilder instance.

addChildProduct

public ProductBuilder addChildProduct(Product product)
                               throws ValidationException

Append another product as child.

Parameters:

intent - Intent object to append to.

Returns:

The current ProductBuilder instance.

Throws:

ValidationException