Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 2.42 KB

README.md

File metadata and controls

32 lines (19 loc) · 2.42 KB

spdx-java-v3jsonld-store

Stores SPDX documents in SPDX version 3 compatible JSON-LD format.

This library utilizes the SPDX Java Library Storage Interface extending the ExtendedSpdxStore which allows for utilizing any underlying store which implements the SPDX Java Library Storage Interface.

The API documentation is available at: https://spdx.github.io/spdx-java-v3jsonld-store/

Code quality badges

Quality Gate Status Bugs Security Rating Maintainability Rating Technical Debt

Using the Library

This library is intended to be used in conjunction with the SPDX Java Library.

Create an instance of a store which implements the SPDX Java Library Storage Interface. For example, the InMemSpdxStore is a simple in-memory storage suitable for simple file serializations and deserializations.

Create an instance of JsonLDStore(IModelStore baseStore, boolean pretty) passing in the instance of a store created above along with the format. If true, pretty will produce more human-readable output including indents as well as license expressions rather than full model license details.

Serializing and Deserializing

This library supports the ISerializableModelStore interface for serializing and deserializing files.

Development Status

Still in development, somewhat unstable.