Package org.spdx.library.model
Copyright (c) 2019 Source Auditor Inc.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
/**
- Author:
- Gary O'Neall Package containing the complete object model for SPDX documents, items, elements, etc. See the SPDX spec model description for a UML diagram of the model
-
Interface Summary Interface Description IndividualUriValue Classes which implement the IndividuallUriValue interface will be stored as a single value. -
Class Summary Class Description Annotation An Annotation is a comment on an SpdxItem by an agent.Checksum A Checksum is value that allows the contents of a file to be authenticated.ExternalDocumentRef Information about an external SPDX document reference including the checksum.ExternalRef An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package.ExternalSpdxElement This is an SPDX element which is in an external document.GenericModelObject Primarily used for testing, this model object does not implement any unique getters and setters nor does it implement any verification.GenericSpdxElement Generic SPDX element - primarily used for testingGenericSpdxItem Generic SPDX item - primarily used for testingModelCollection<T> Collection of elements stored in a ModelStoreModelObject ModelSet<T> A ModelCollection implemented as a set where all items in the collection are unique based on equality (not based on equivalence).ModelStorageClassConverter This static helper class converts objects used in the model to and from objects used by the SPI / storage class.ReferenceType Type of external reference Note that there are very few required fields for this class in that the external reference type does not need to be provided in the SPDX document for the document to be valid.RelatedElementCollection Relationship A Relationship represents a relationship between two SpdxElements.SimpleUriValue Simple class to just store a URI value.SpdxConstantElement Type of SpdxElement which is a constant unmodifiable elementSpdxCreatorInformation SpdxDocument An SpdxDocument is a summary of the contents, provenance, ownership and licensing analysis of a specific software package.SpdxElement An SpdxElement is any thing described in SPDX, either a document or an SpdxItem.SpdxFile A File represents a named sequence of information that is contained in a software package.SpdxFile.SpdxFileBuilder SpdxItem An SpdxItem is a potentially copyrightable work.SpdxModelFactory Factory class to create ModelObjects based on the type Types are defined classes in the SpdxConstants class and map to the standard SPDX modelSpdxNoAssertionElement This SPDX element represents no assertion as to an actual SPDX element.SpdxNoneElement This SPDX element represents no SPDX element at all.SpdxPackage A Package represents a collection of software files that are delivered as a single functional component.SpdxPackage.SpdxPackageBuilder SpdxPackageVerificationCode SpdxSnippet Snippets can optionally be used when a file is known to have some content that has been included from another original source.SpdxSnippet.SpdxSnippetBuilder TypedValue Value which is a stored typed item -
Exception Summary Exception Description DuplicateSpdxIdException InvalidSpdxPropertyException SpdxIdInUseException Exception when an SPDX element is in use (e.g.SpdxIdNotFoundException SpdxInvalidTypeException