us.springett.parsers.cpe.util

Class Convert

java.lang.Object

us.springett.parsers.cpe.util.Convert

public final class Convert
extends Object

Set of methods to encode and decode text based on the CPE specification.

Author:

Jeremy Long

Method Summary

Modifier and Type	Method and Description
static String	cpeUriToWellFormed(String value) CPE URI decodes the value into a well formed string.
static String	cpeUriToWellFormed(String value, boolean lenient) CPE URI decodes the value into a well formed string.
static String	fromWellFormed(String value) Transforms the given well formed string into a non-escaped string.
static String	fsToWellFormed(String value) Transforms a formatted string (CPE 2.3 specification) into a Well Formed string.
static String	fsToWellFormed(String value, boolean lenient) Transforms a formatted string (CPE 2.3 specification) into a Well Formed string.
static String	toWellFormed(String value) Transforms the given string into a "well formed string".
static String	wellFormedToCpeUri(Part value) URL encodes the value for CPE 2.2.
static String	wellFormedToCpeUri(String wellFormed) CPE URL encodes the well formed string.
static String	wellFormedToFS(Part value) Encodes the given value into the CPE 2.3 Formatted String representation.
static String	wellFormedToFS(String value) Transforms a Well Formed string into a formatted string (see CPE 2.3 specification).
static Pattern	wellFormedToPattern(String value) Converts a well formed string into a regular expression pattern.

Methods inherited from class java.lang.Object

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

Method Detail

toWellFormed

public static String toWellFormed(String value)

Transforms the given string into a "well formed string". A well formed string has all non-alphanumeric characters escaped with a backslash. If a null value is passed in the default LogicalValue.ANY will be returned.

Parameters:

value - the string to format

Returns:

the well formed string

fromWellFormed

public static String fromWellFormed(String value)

Transforms the given well formed string into a non-escaped string. A well formed string has all non-alphanumeric characters escaped with a backslash.

Parameters:

value - the well formed string

Returns:

the string value represented by the well formed string

wellFormedToCpeUri

public static String wellFormedToCpeUri(Part value)

URL encodes the value for CPE 2.2. If the value is NULL or ANY ('*') then an empty string is returned. If the value is a hyphen ('-') the hyphen is returned un-encoded; otherwise URL encoding is applied.

Parameters:

value - the value to encode

Returns:

the encoded value

wellFormedToCpeUri

public static String wellFormedToCpeUri(String wellFormed)
                                 throws CpeEncodingException

CPE URL encodes the well formed string. If the value is NULL or ANY ('*') then an empty string is returned. If the value is a hyphen ('-') the hyphen is returned un-encoded; otherwise URL encoding is applied as specified in the CPE 2.2 format.

Parameters:

wellFormed - the well formed string to convert

Returns:

the CPE URI encoded representation of the well formed string

Throws:

CpeEncodingException - thrown if the string provided is not well formed

cpeUriToWellFormed

public static String cpeUriToWellFormed(String value)
                                 throws CpeEncodingException

CPE URI decodes the value into a well formed string. If the value is NULL or an empty string then a the LogicalValue.ANY ('*') is returned.

Parameters:

value - the CPE URI encoded string to convert

Returns:

the well formed string representation of the given value

Throws:

CpeEncodingException - thrown if the string provided is not well formed

cpeUriToWellFormed

public static String cpeUriToWellFormed(String value,
                                        boolean lenient)
                                 throws CpeEncodingException

CPE URI decodes the value into a well formed string. If the value is NULL or an empty string then a the LogicalValue.ANY ('*') is returned.

Parameters:

value - the CPE URI encoded string to convert

lenient - whether or not to enable lenient parsing of the CPE URI value

Returns:

the well formed string representation of the given value

Throws:

CpeEncodingException - thrown if the string provided is not well formed

wellFormedToFS

public static String wellFormedToFS(Part value)

Encodes the given value into the CPE 2.3 Formatted String representation.

Parameters:

value - the component value to encode

Returns:

the formatted string

wellFormedToFS

public static String wellFormedToFS(String value)

Transforms a Well Formed string into a formatted string (see CPE 2.3 specification).

Parameters:

value - the component value to encode

Returns:

the formatted string

fsToWellFormed

public static String fsToWellFormed(String value)

Transforms a formatted string (CPE 2.3 specification) into a Well Formed string.

Parameters:

value - the component value to transform

Returns:

the formatted string

fsToWellFormed

public static String fsToWellFormed(String value,
                                    boolean lenient)

Transforms a formatted string (CPE 2.3 specification) into a Well Formed string.

Parameters:

value - the component value to transform

lenient - whether or not to enable lenient parsing of the CPE FS value

Returns:

the formatted string

wellFormedToPattern

public static Pattern wellFormedToPattern(String value)

Converts a well formed string into a regular expression pattern.

Parameters:

value - the well formed string to convert

Returns:

the generated pattern object