us.springett.parsers.cpe

Class CpeBuilder

java.lang.Object

us.springett.parsers.cpe.CpeBuilder

public class CpeBuilder
extends Object

A builder for CPE objects.

Author:

Jeremy Long

Constructor Summary

Constructors

Constructor and Description
CpeBuilder()

Method Summary

Modifier and Type	Method and Description
Cpe	build() Builds the CPE Object.
CpeBuilder	edition(LogicalValue edition) Sets the edition for the CPE entry.
CpeBuilder	edition(String edition) Sets the edition for the CPE entry.
protected String	getEdition() Get the value of edition.
protected String	getLanguage() Get the value of language.
protected String	getOther() Get the value of other.
protected Part	getPart() Get the value of part.
protected String	getProduct() Get the value of product.
protected String	getSwEdition() Get the value of swEdition.
protected String	getTargetHw() Get the value of targetHw.
protected String	getTargetSw() Get the value of targetSw.
protected String	getUpdate() Get the value of update.
protected String	getVendor() Get the value of vendor.
protected String	getVersion() Get the value of version.
CpeBuilder	language(LogicalValue language) Sets the language for the CPE entry.
CpeBuilder	language(String language) Sets the language for the CPE entry.
CpeBuilder	other(LogicalValue other) Sets the other component for the CPE entry.
CpeBuilder	other(String other) Sets the other component for the CPE entry.
CpeBuilder	part(Part part) Sets the type for the CPE entry: application, operating system, or hardware.
CpeBuilder	part(String part) Sets the type for the CPE entry: application, operating system, or hardware.
CpeBuilder	product(LogicalValue product) Sets the product for the CPE entry.
CpeBuilder	product(String product) Sets the product for the CPE entry.
protected void	reset() Resets the CPE Builder to a clean state.
CpeBuilder	swEdition(LogicalValue swEdition) Sets the software edition for the CPE entry.
CpeBuilder	swEdition(String swEdition) Sets the software edition for the CPE entry.
CpeBuilder	targetHw(LogicalValue targetHw) Sets the target hardware environment for the CPE entry.
CpeBuilder	targetHw(String targetHw) Sets the target hardware environment for the CPE entry.
CpeBuilder	targetSw(LogicalValue targetSw) Sets the target software environment for the CPE entry.
CpeBuilder	targetSw(String targetSw) Sets the target software environment for the CPE entry.
CpeBuilder	update(LogicalValue update) Sets the update version for the CPE entry.
CpeBuilder	update(String update) Sets the update version for the CPE entry.
CpeBuilder	vendor(LogicalValue vendor) Sets the vendor for the CPE entry.
CpeBuilder	vendor(String vendor) Sets the vendor for the CPE entry.
CpeBuilder	version(LogicalValue version) Sets the version for the CPE entry.
CpeBuilder	version(String version) Sets the version for the CPE entry.
CpeBuilder	wfEdition(String edition) Sets the edition for the CPE entry as a Well Formed string.
CpeBuilder	wfLanguage(String language) Sets the language for the CPE entry as a Well Formed string.
CpeBuilder	wfOther(String other) Sets the other component for the CPE entry as a Well Formed Name attribute.
CpeBuilder	wfProduct(String product) Sets the product for the CPE entry as a Well Formed string.
CpeBuilder	wfSwEdition(String swEdition) Sets the software edition for the CPE entry as a Well Formed Name attribute.
CpeBuilder	wfTargetHw(String targetHw) Sets the target hardware environment for the CPE entry as a Well Formed Name attribute.
CpeBuilder	wfTargetSw(String targetSw) Sets the target software environment for the CPE entry as a Well Formed Name attribute.
CpeBuilder	wfUpdate(String update) Sets the update version for the CPE entry as a Well Formed string.
CpeBuilder	wfVendor(String vendor) Sets the vendor for the CPE entry as a Well Formed string.
CpeBuilder	wfVersion(String version) Sets the version for the CPE entry as a Well Formed string.

Methods inherited from class java.lang.Object

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

Constructor Detail

CpeBuilder

public CpeBuilder()

Method Detail

reset

protected void reset()

Resets the CPE Builder to a clean state.

part

public CpeBuilder part(Part part)

Sets the type for the CPE entry: application, operating system, or hardware.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

part - the type of CPE entry: application, operating system, or hardware

Returns:

the builder

part

public CpeBuilder part(String part)
                throws CpeParsingException

Sets the type for the CPE entry: application, operating system, or hardware.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

part - the type of CPE entry: application, operating system, or hardware

Returns:

the builder

Throws:

CpeParsingException - thrown if an invalid part type is specified

vendor

public CpeBuilder vendor(String vendor)

Sets the vendor for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

vendor - the vendor name

Returns:

the builder

product

public CpeBuilder product(String product)

Sets the product for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

product - the product name

Returns:

the builder

version

public CpeBuilder version(String version)

Sets the version for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

version - the version number

Returns:

the builder

update

public CpeBuilder update(String update)

Sets the update version for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

update - the update version

Returns:

the builder

edition

public CpeBuilder edition(String edition)

Sets the edition for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

edition - the edition name

Returns:

the builder

language

public CpeBuilder language(String language)

Sets the language for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

language - the language name

Returns:

the builder

swEdition

public CpeBuilder swEdition(String swEdition)

Sets the software edition for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

swEdition - the software edition

Returns:

the builder

targetSw

public CpeBuilder targetSw(String targetSw)

Sets the target software environment for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

targetSw - the target software environment

Returns:

the builder

targetHw

public CpeBuilder targetHw(String targetHw)

Sets the target hardware environment for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

targetHw - the target hardware environment

Returns:

the builder

other

public CpeBuilder other(String other)

Sets the other component for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

other - the other component

Returns:

the builder

vendor

public CpeBuilder vendor(LogicalValue vendor)

Sets the vendor for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

vendor - the logical value of NA or ANY

Returns:

the builder

product

public CpeBuilder product(LogicalValue product)

Sets the product for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

product - the logical value of NA or ANY

Returns:

the builder

version

public CpeBuilder version(LogicalValue version)

Sets the version for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

version - the logical value of NA or ANY

Returns:

the builder

update

public CpeBuilder update(LogicalValue update)

Sets the update version for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

update - the logical value of NA or ANY

Returns:

the builder

edition

public CpeBuilder edition(LogicalValue edition)

Sets the edition for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

edition - the logical value of NA or ANY

Returns:

the builder

language

public CpeBuilder language(LogicalValue language)

Sets the language for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

language - the logical value of NA or ANY

Returns:

the builder

swEdition

public CpeBuilder swEdition(LogicalValue swEdition)

Sets the software edition for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

swEdition - the logical value of NA or ANY

Returns:

the builder

targetSw

public CpeBuilder targetSw(LogicalValue targetSw)

Sets the target software environment for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

targetSw - the logical value of NA or ANY

Returns:

the builder

targetHw

public CpeBuilder targetHw(LogicalValue targetHw)

Sets the target hardware environment for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

targetHw - the logical value of NA or ANY

Returns:

the builder

other

public CpeBuilder other(LogicalValue other)

Sets the other component for the CPE entry.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

other - the logical value of NA or ANY

Returns:

the builder

wfVendor

public CpeBuilder wfVendor(String vendor)

Sets the vendor for the CPE entry as a Well Formed string. See the CPE 2.3 Specification for more information on Well Formed Names.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

vendor - the vendor name

Returns:

the builder

wfProduct

public CpeBuilder wfProduct(String product)

Sets the product for the CPE entry as a Well Formed string. See the CPE 2.3 Specification for more information on Well Formed Names.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

product - the product name

Returns:

the builder

wfVersion

public CpeBuilder wfVersion(String version)

Sets the version for the CPE entry as a Well Formed string. See the CPE 2.3 Specification for more information on Well Formed Names.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

version - the version number

Returns:

the builder

wfUpdate

public CpeBuilder wfUpdate(String update)

Sets the update version for the CPE entry as a Well Formed string. See the CPE 2.3 Specification for more information on Well Formed Names.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

update - the update version

Returns:

the builder

wfEdition

public CpeBuilder wfEdition(String edition)

Sets the edition for the CPE entry as a Well Formed string. See the CPE 2.3 Specification for more information on Well Formed Names.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

edition - the edition name

Returns:

the builder

wfLanguage

public CpeBuilder wfLanguage(String language)

Sets the language for the CPE entry as a Well Formed string. See the CPE 2.3 Specification for more information on Well Formed Names.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

language - the language name

Returns:

the builder

wfSwEdition

public CpeBuilder wfSwEdition(String swEdition)

Sets the software edition for the CPE entry as a Well Formed Name attribute. See the CPE 2.3 Specification for more information on Well Formed Names.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

swEdition - the software edition

Returns:

the builder

wfTargetSw

public CpeBuilder wfTargetSw(String targetSw)

Sets the target software environment for the CPE entry as a Well Formed Name attribute. See the CPE 2.3 Specification for more information on Well Formed Names.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

targetSw - the target software environment

Returns:

the builder

wfTargetHw

public CpeBuilder wfTargetHw(String targetHw)

Sets the target hardware environment for the CPE entry as a Well Formed Name attribute. See the CPE 2.3 Specification for more information on Well Formed Names.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

targetHw - the target hardware environment

Returns:

the builder

wfOther

public CpeBuilder wfOther(String other)

Sets the other component for the CPE entry as a Well Formed Name attribute. See the CPE 2.3 Specification for more information on Well Formed Names.

cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]

Parameters:

other - the other component

Returns:

the builder

getPart

protected Part getPart()

Get the value of part.

Returns:

the value of part

getVendor

protected String getVendor()

Get the value of vendor.

Returns:

the value of vendor

getProduct

protected String getProduct()

Get the value of product.

Returns:

the value of product

getVersion

protected String getVersion()

Get the value of version.

Returns:

the value of version

getUpdate

protected String getUpdate()

Get the value of update.

Returns:

the value of update

getEdition

protected String getEdition()

Get the value of edition.

Returns:

the value of edition

getLanguage

protected String getLanguage()

Get the value of language.

Returns:

the value of language

getSwEdition

protected String getSwEdition()

Get the value of swEdition.

Returns:

the value of swEdition

getTargetSw

protected String getTargetSw()

Get the value of targetSw.

Returns:

the value of targetSw

getTargetHw

protected String getTargetHw()

Get the value of targetHw.

Returns:

the value of targetHw

getOther

protected String getOther()

Get the value of other.

Returns:

the value of other

build

public Cpe build()
          throws CpeValidationException

Builds the CPE Object.

Returns:

the CPE Object

Throws:

CpeValidationException - thrown if one of the CPE components is invalid