Package org.spdx.library.model.v2

Class SpdxVerificationHelper

java.lang.Object

org.spdx.library.model.v2.SpdxVerificationHelper

public class SpdxVerificationHelper
extends Object

Holds static methods used for verify various property values

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field	Description
static List<String>	SUPPORTED_SPDX_VERSIONS

Constructor Summary

Constructors

Constructor	Description
SpdxVerificationHelper()

Method Summary

Modifier and Type	Method	Description
static boolean	equalsWithNull(Object s1, Object s2)	Returns true if s1 equals s2 taking into account the possibility of null values
static boolean	equivalentArray(Object[] s1, Object[] s2)	Returns true if the array s1 contains the same objects as s2 independent of order and allowing for null values
static boolean	isValidExternalDocRef(String externalDocumentId)
static boolean	isValidUri(String uri)
static String	verifyAnnotator(String annotator)
static String	verifyChecksumString(String checksum, ChecksumAlgorithm algorithm, String specVersion)
static String	verifyCreator(String creator)	Verifies a creator string value
static String	verifyDate(String creationDate)
static String	verifyDownloadLocation(String downloadLocation)	Verify a download location per section 3.7.5 of the spec
static String	verifyNonStdLicenseid(String licenseUri)	Deprecated.
static String	verifyNonStdLicenseId(String licenseUri)
static String	verifyOriginator(String originator)	Verifies the originator string
static String	verifyReviewer(String reviewer)
static boolean	verifySpdxId(String objectUri)
static String	verifySpdxVersion(String spdxVersion)	Verifies an SPDX version 2.X version string
static String	verifySupplier(String supplier)	Verifies the supplier String
static boolean	versionLessThan(String specVersion, String compareSpecVersion)	Compares versions of the SPDX spec

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED_SPDX_VERSIONS

public static final List<String> SUPPORTED_SPDX_VERSIONS

Constructor Detail

SpdxVerificationHelper

public SpdxVerificationHelper()

Method Detail

verifyNonStdLicenseId

public static String verifyNonStdLicenseId(String licenseUri)

verifyCreator

public static String verifyCreator(String creator)

Verifies a creator string value

Parameters:

creator -

Returns:

verifyOriginator

public static String verifyOriginator(String originator)

Verifies the originator string

Parameters:

originator -

Returns:

verifySupplier

public static String verifySupplier(String supplier)

Verifies the supplier String

Parameters:

supplier -

Returns:

verifyNonStdLicenseid

@Deprecated
public static String verifyNonStdLicenseid(String licenseUri)

Deprecated.

verifyDate

public static String verifyDate(String creationDate)

Parameters:

creationDate -

Returns:

error message or null if no error

verifyReviewer

public static String verifyReviewer(String reviewer)

Parameters:

reviewer -

Returns:

equalsWithNull

public static boolean equalsWithNull(Object s1,
                                     Object s2)

Returns true if s1 equals s2 taking into account the possibility of null values

Parameters:

s1 -

s2 -

Returns:

equivalentArray

public static boolean equivalentArray(Object[] s1,
                                      Object[] s2)

Returns true if the array s1 contains the same objects as s2 independent of order and allowing for null values

Parameters:

s1 -

s2 -

Returns:

verifyAnnotator

public static String verifyAnnotator(String annotator)

Parameters:

annotator -

Returns:

isValidExternalDocRef

public static boolean isValidExternalDocRef(String externalDocumentId)

Parameters:

externalDocumentId -

Returns:

isValidUri

public static boolean isValidUri(String uri)

verifyChecksumString

public static String verifyChecksumString(String checksum,
                                          ChecksumAlgorithm algorithm,
                                          String specVersion)

verifyDownloadLocation

public static String verifyDownloadLocation(String downloadLocation)

Verify a download location per section 3.7.5 of the spec

Parameters:

downloadLocation -

Returns:

null if a valid string otherwise a description of the error

verifySpdxId

public static boolean verifySpdxId(String objectUri)

Parameters:

objectUri -

Returns:

true if the ID is a valid SPDX ID reference

verifySpdxVersion

public static String verifySpdxVersion(String spdxVersion)

Verifies an SPDX version 2.X version string

Parameters:

spdxVersion - version to verify

Returns:

null if no errors, otherwise a string error message

versionLessThan

public static boolean versionLessThan(String specVersion,
                                      String compareSpecVersion)

Compares versions of the SPDX spec

Parameters:

specVersion -

compareSpecVersion -

Returns:

true if specVersion is less than compareSpecVersion