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.

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.
ProductBuilder(Node productNode) Custom constructor.
ProductBuilder(Product product) Custom Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildProduct(Product childRef) Append another product as child.
void	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(Node productNode)
               throws JAXBException

Custom constructor. Accepting a W3C Node object for initializing.

Parameters:

productNode - W2C Node object for

Throws:

JAXBException

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

productType - Value of ProductType attribute

productTypeDetails - Value of ProductTypeDetails attribute

descriptiveName - String value for DescriptiveName attribute.

ProductBuilder

public ProductBuilder(Product product)

Custom Constructor. Creates a new instance of ProductBuilder based on a existing Product Node.

Parameters:

product - Product node for initializing.

Method Detail

getProduct

protected Product getProduct()

Getter for product attribute.

Returns:

the product

addIntent

public void addIntent(IntentType intent)

Append Intent node to Product Definition.

Parameters:

intent - Intent object to append to.

addChildProduct

public final void addChildProduct(Product childRef)
                           throws IllegalArgumentException

Append another product as child.

Parameters:

childRef - Reference to the child product to append.

Throws:

IllegalArgumentException