ICpe (CPE Parser 2.1.0 API)

All Superinterfaces:

Comparable

All Known Implementing Classes:

Cpe
```
public interface ICpe
extends Comparable
```
Object representation of a Common Platform Enumeration (CPE).

Author:

Jeremy Long

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getEdition()` Gets the edition for the CPE entry.
`String`	`getLanguage()` Gets the language for the CPE entry.
`String`	`getOther()` Gets the other component for the CPE entry.
`Part`	`getPart()` Gets the part for the CPE entry.
`String`	`getProduct()` Gets the product for the CPE entry.
`String`	`getSwEdition()` Gets the software edition for the CPE entry.
`String`	`getTargetHw()` Gets the target hardware environment for the CPE entry.
`String`	`getTargetSw()` Gets the target software environment for the CPE entry.
`String`	`getUpdate()` Gets the update for the CPE entry.
`String`	`getVendor()` Gets the vendor for the CPE entry.
`String`	`getVersion()` Gets the version for the CPE entry.
`String`	`getWellFormedEdition()` Gets the well formed formatted edition for the CPE entry.
`String`	`getWellFormedLanguage()` Gets the well formed formatted language for the CPE entry.
`String`	`getWellFormedOther()` Gets the well formed formatted other component for the CPE entry.
`String`	`getWellFormedProduct()` Gets the well formed formatted product for the CPE entry.
`String`	`getWellFormedSwEdition()` Gets the well formed formatted software edition for the CPE entry.
`String`	`getWellFormedTargetHw()` Gets the well formed formatted target hardware environment for the CPE entry.
`String`	`getWellFormedTargetSw()` Gets the well formed formatted target software environment for the CPE entry.
`String`	`getWellFormedUpdate()` Gets the well formed formatted update for the CPE entry.
`String`	`getWellFormedVendor()` Gets the well formed formatted vendor for the CPE entry.
`String`	`getWellFormedVersion()` Gets the well formed formatted version for the CPE entry.
`boolean`	`matchedBy(ICpe target)` Determines if the target CPE matches the CPE.
`boolean`	`matches(ICpe target)` Determines if the CPE matches the given target CPE.
`String`	`toCpe22Uri()` Converts the CPE into the CPE 2.2 URI format.
`String`	`toCpe23FS()` Converts the CPE into the CPE 2.3 Formatted String.

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - getPart
```
Part getPart()
```
    Gets the part for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the part for the CPE entry
  - getVendor
```
String getVendor()
```
    Gets the vendor for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the vendor for the CPE entry
  - getProduct
```
String getProduct()
```
    Gets the product for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the product for the CPE entry
  - getVersion
```
String getVersion()
```
    Gets the version for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the version for the CPE entry
  - getUpdate
```
String getUpdate()
```
    Gets the update for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the update for the CPE entry
  - getEdition
```
String getEdition()
```
    Gets the edition for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the edition for the CPE entry
  - getLanguage
```
String getLanguage()
```
    Gets the language for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the language for the CPE entry
  - getSwEdition
```
String getSwEdition()
```
    Gets the software edition for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the software edition for the CPE entry
  - getTargetSw
```
String getTargetSw()
```
    Gets 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]
```
    Returns:
    
    the target software environment for the CPE entry.
  - getTargetHw
```
String getTargetHw()
```
    Gets 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]
```
    Returns:
    
    the target hardware environment for the CPE entry
  - getOther
```
String getOther()
```
    Gets the other component for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the other component for the CPE entry
  - getWellFormedVendor
```
String getWellFormedVendor()
```
    Gets the well formed formatted vendor for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the vendor for the CPE entry
  - getWellFormedProduct
```
String getWellFormedProduct()
```
    Gets the well formed formatted product for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the product for the CPE entry
  - getWellFormedVersion
```
String getWellFormedVersion()
```
    Gets the well formed formatted version for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the version for the CPE entry
  - getWellFormedUpdate
```
String getWellFormedUpdate()
```
    Gets the well formed formatted update for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the update for the CPE entry
  - getWellFormedEdition
```
String getWellFormedEdition()
```
    Gets the well formed formatted edition for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the edition for the CPE entry
  - getWellFormedLanguage
```
String getWellFormedLanguage()
```
    Gets the well formed formatted language for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the language for the CPE entry
  - getWellFormedSwEdition
```
String getWellFormedSwEdition()
```
    Gets the well formed formatted software edition for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the software edition for the CPE entry
  - getWellFormedTargetSw
```
String getWellFormedTargetSw()
```
    Gets the well formed formatted target software environment for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the target software environment for the CPE entry.
  - getWellFormedTargetHw
```
String getWellFormedTargetHw()
```
    Gets the well formed formatted target hardware environment for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the target hardware environment for the CPE entry
  - getWellFormedOther
```
String getWellFormedOther()
```
    Gets the well formed formatted other component for the CPE entry.
```
cpe:2.3:[part]:[vendor]:[product]:[version]:[update]:[edition]:[language]:[sw_edition]:[target_sw]:[target_hw]:[other]
```
    Returns:
    
    the other component for the CPE entry
  - toCpe22Uri
```
String toCpe22Uri()
           throws CpeEncodingException
```
    Converts the CPE into the CPE 2.2 URI format.
    
    Returns:
    
    the CPE 2.2 URI format of the CPE
    
    Throws:
    
    CpeEncodingException - thrown if the CPE is not well formed
  - toCpe23FS
```
String toCpe23FS()
```
    Converts the CPE into the CPE 2.3 Formatted String.
    
    Returns:
    
    the CPE 2.3 Formatted String
  - matches
```
boolean matches(ICpe target)
```
    Determines if the CPE matches the given target CPE. This does not follow the CPE 2.3 Specification exactly as there are cases where undefined comparisons will result in either true or false. For instance, 'ANY' will match 'm+wild cards' and NA will return false when the target has 'm+wild cards'.
    
    Parameters:
    
    target - the target CPE to evaluate
    
    Returns:
    
    true if the CPE matches the target; otherwise false
  - matchedBy
```
boolean matchedBy(ICpe target)
```
    Determines if the target CPE matches the CPE. This does not follow the CPE 2.3 Specification exactly as there are cases where undefined comparisons will result in either true or false. For instance, 'ANY' will match 'm+wild cards' and NA will return false when the target has 'm+wild cards'.
    
    Parameters:
    
    target - the CPE to evaluate
    
    Returns:
    
    true if the target CPE matches CPE; otherwise false

Interface ICpe

Method Summary

Methods inherited from interface java.lang.Comparable

Method Detail

getPart

getVendor

getProduct

getVersion

getUpdate

getEdition

getLanguage

getSwEdition

getTargetSw

getTargetHw

getOther

getWellFormedVendor

getWellFormedProduct

getWellFormedVersion

getWellFormedUpdate

getWellFormedEdition

getWellFormedLanguage

getWellFormedSwEdition

getWellFormedTargetSw

getWellFormedTargetHw

getWellFormedOther

toCpe22Uri

toCpe23FS

matches

matchedBy