us.springett.parsers.cpe

Class CpeParser

java.lang.Object

us.springett.parsers.cpe.CpeParser

public final class CpeParser
extends Object

A Common Platform Enumeration (CPE) parser. This parser is capable of parsing CPE 2.2 and 2.3 strings.

Author:

Jeremy Long

Method Summary

Modifier and Type	Method and Description
static Cpe	parse(String cpeString) Parses a CPE String into an object; the string can be formated as either a CPE 2.2 URI or CPE 2.3 Formatted String.
static Cpe	parse(String cpeString, boolean lenient) Parses a CPE String into an object with the option of parsing CPE 2.2 URI strings in lenient mode - allowing for CPE values that do not adhere to the specification.
protected static Cpe	parse22(String cpeString) Parses a CPE 2.2 URI.
protected static Cpe	parse22(String cpeString, boolean lenient) Parses a CPE 2.2 URI.
protected static Cpe	parse23(String cpeString) Parses a CPE 2.3 Formatted String.
protected static Cpe	parse23(String cpeString, boolean lenient) Parses a CPE 2.3 Formatted String.
protected static void	unpackEdition(String edition, CpeBuilder cb, boolean lenient) In a CPE 2.2 URI the new fields from CPE 2.3 may be "packed" into the edition field.

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static Cpe parse(String cpeString)
                 throws CpeParsingException

Parses a CPE String into an object; the string can be formated as either a CPE 2.2 URI or CPE 2.3 Formatted String.

Parameters:

cpeString - the CPE string to parse

Returns:

the CPE object represented by the given cpeString

Throws:

CpeParsingException - thrown if the cpeString is invalid

parse

public static Cpe parse(String cpeString,
                        boolean lenient)
                 throws CpeParsingException

Parses a CPE String into an object with the option of parsing CPE 2.2 URI strings in lenient mode - allowing for CPE values that do not adhere to the specification.

Parameters:

cpeString - the CPE string to parse

lenient - when true the CPE 2.2 parser will put in lenient mode attempting to parse invalid CPE URI values.

Returns:

the CPE object represented by the given cpeString

Throws:

CpeParsingException - thrown if the cpeString is invalid

parse22

protected static Cpe parse22(String cpeString)
                      throws CpeParsingException

Parses a CPE 2.2 URI.

Parameters:

cpeString - the CPE string to parse

Returns:

the CPE object represented by the cpeString

Throws:

CpeParsingException - thrown if the cpeString is invalid

parse22

protected static Cpe parse22(String cpeString,
                             boolean lenient)
                      throws CpeParsingException

Parses a CPE 2.2 URI.

Parameters:

cpeString - the CPE string to parse

lenient - when true the parser will put in lenient mode attempting to parse invalid CPE values.

Returns:

the CPE object represented by the cpeString

Throws:

CpeParsingException - thrown if the cpeString is invalid

unpackEdition

protected static void unpackEdition(String edition,
                                    CpeBuilder cb,
                                    boolean lenient)
                             throws CpeParsingException

In a CPE 2.2 URI the new fields from CPE 2.3 may be "packed" into the edition field. If present, each field will be preceded by a '~'. Example, "~edition~swEdition~targetSw~targetHw~other".

Parameters:

edition - the edition string to unpack

cb - a reference to the CPE Builder to unpack the edition into

lenient - whether or not to use lenient parsing

Throws:

CpeParsingException - thrown if the edition value is invalid

parse23

protected static Cpe parse23(String cpeString)
                      throws CpeParsingException

Parses a CPE 2.3 Formatted String.

Parameters:

cpeString - the CPE string to parse

Returns:

the CPE object represented by the cpeString

Throws:

CpeParsingException - thrown if the cpeString is invalid

parse23

protected static Cpe parse23(String cpeString,
                             boolean lenient)
                      throws CpeParsingException

Parses a CPE 2.3 Formatted String.

Parameters:

cpeString - the CPE string to parse

lenient - when true the parser will put in lenient mode attempting to parse invalid CPE values.

Returns:

the CPE object represented by the cpeString

Throws:

CpeParsingException - thrown if the cpeString is invalid