Package org.spdx.library

Class Read.Document

java.lang.Object

org.spdx.library.Read.Document

Enclosing class:

Read

public static class Read.Document
extends Object

Constructor Summary

Constructors

Constructor	Description
Document()

Method Summary

Modifier and Type	Method	Description
static boolean	documentExists(IModelStore modelStore, String documentUri)
static List<SpdxDocument>	get(IModelStore modelStore)	Obtains the SPDX Documents described in the provided model store.
static SpdxDocument	get(IModelStore modelStore, String documentUri)

Methods inherited from class java.lang.Object

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

Constructor Details

Document

public Document()

Method Details

get

public static List<SpdxDocument> get(IModelStore modelStore) throws InvalidSPDXAnalysisException, IOException

Obtains the SPDX Documents described in the provided model store. A document store may contain multiple SPDX documents identified by their unique document URI's

Parameters:

modelStore - Storage for the model objects

Returns:

List of SPDX documents contained in the modelStore

Throws:

InvalidSPDXAnalysisException

IOException

get

public static SpdxDocument get(IModelStore modelStore, String documentUri) throws InvalidSPDXAnalysisException, IOException

Parameters:

modelStore - Storage for the model objects

documentUri - SPDX Document URI for a document associated with this model

Returns:

the SPDX document

Throws:

InvalidSPDXAnalysisException

IOException

documentExists

public static boolean documentExists(IModelStore modelStore, String documentUri)

Parameters:

modelStore - Storage for the model objects

documentUri - SPDX Document URI for a document associated with this model

Returns:

true if the document exists in the model store