Class CrossRefJson

java.lang.Object
org.spdx.storage.listedlicense.CrossRefJson
public class CrossRefJson extends Object
JSON Representation of a CrossRef
Author:
Gary O'Neall

  • Field Details

  • Constructor Details

    • CrossRefJson

      public CrossRefJson()
      Default constructor for GSON compatibility

    • CrossRefJson

      public CrossRefJson(org.spdx.library.model.v2.license.CrossRef crossRef) throws org.spdx.core.InvalidSPDXAnalysisException
      Construct a CrossRefJson object by copying values from a CrossRef object
      Parameters:
      crossRef - The CrossRef object to copy values from.
      Throws:
      org.spdx.core.InvalidSPDXAnalysisException - on SPDX parsing errors

  • Method Details

    • getPropertyValueDescriptors

      public List<org.spdx.storage.PropertyDescriptor> getPropertyValueDescriptors()
      Retrieve all valid property descriptors for this object
      Returns:
      all valid property descriptors

    • setPrimitiveValue

      public void setPrimitiveValue(org.spdx.storage.PropertyDescriptor propertyDescriptor, Object value) throws org.spdx.core.InvalidSpdxPropertyException
      Set the value to the property name
      Parameters:
      propertyDescriptor - descriptor for the property to set
      value - Value to set
      Throws:
      org.spdx.core.InvalidSpdxPropertyException - on SPDX parsing errors

    • clearPropertyValueList

      public void clearPropertyValueList(org.spdx.storage.PropertyDescriptor propertyDescriptor) throws org.spdx.core.InvalidSpdxPropertyException
      Throws:
      org.spdx.core.InvalidSpdxPropertyException

    • addPrimitiveValueToList

      public boolean addPrimitiveValueToList(org.spdx.storage.PropertyDescriptor propertyDescriptor, Object value) throws org.spdx.core.InvalidSpdxPropertyException
      Throws:
      org.spdx.core.InvalidSpdxPropertyException

    • removePrimitiveValueToList

      public boolean removePrimitiveValueToList(org.spdx.storage.PropertyDescriptor propertyDescriptor, Object value) throws org.spdx.core.InvalidSpdxPropertyException
      Throws:
      org.spdx.core.InvalidSpdxPropertyException

    • getId

      @Nullable public String getId()
      Get the crossRefId
      Returns:
      The crossRefId

    • setId

      public void setId(String crossRefId)
      Set the crossRefId
      Parameters:
      crossRefId -

    • getValueList

      public List<?> getValueList(org.spdx.storage.PropertyDescriptor propertyDescriptor) throws org.spdx.core.InvalidSpdxPropertyException
      Parameters:
      propertyDescriptor - descriptor for the property to set
      Returns:
      the list associated with the property
      Throws:
      org.spdx.core.InvalidSpdxPropertyException - on SPDX parsing errors

    • getValue

      @Nullable public Object getValue(org.spdx.storage.PropertyDescriptor propertyDescriptor) throws org.spdx.core.InvalidSpdxPropertyException
      Retrieve the value associated with the given property descriptor
      Parameters:
      propertyDescriptor - descriptor for the property to set
      Returns:
      the value associated with the property - null if not assigned or not present
      Throws:
      org.spdx.core.InvalidSpdxPropertyException - on SPDX parsing errors

    • removeProperty

      public void removeProperty(org.spdx.storage.PropertyDescriptor propertyDescriptor) throws org.spdx.core.InvalidSpdxPropertyException
      Set the property to null (no way to remove in this store)
      Parameters:
      propertyDescriptor - Descriptor for the property to set
      Throws:
      org.spdx.core.InvalidSpdxPropertyException - on SPDX parsing errors

    • isCollectionMembersAssignableTo

      public boolean isCollectionMembersAssignableTo(org.spdx.storage.PropertyDescriptor propertyDescriptor, Class<?> clazz)
      Check whether the members of the collection can be assigned to the given class

      Note: This is not implemented for this class and always returns false.

      Parameters:
      propertyDescriptor - descriptor for the property to set
      clazz - target class
      Returns:
      true if the members can be assigned from clazz

    • isPropertyValueAssignableTo

      public boolean isPropertyValueAssignableTo(org.spdx.storage.PropertyDescriptor propertyDescriptor, Class<?> clazz) throws org.spdx.core.InvalidSpdxPropertyException
      Check whether the property value can be assigned to the given class
      Parameters:
      propertyDescriptor - descriptor for the property to set
      clazz - target class
      Returns:
      true if the property can be assigned from clazz
      Throws:
      org.spdx.core.InvalidSpdxPropertyException - on SPDX parsing errors

    • isCollectionProperty

      public boolean isCollectionProperty(String propertyName)
      Check whether the property is a collection

      Note: This is not implemented for this class and always returns false.

      Parameters:
      propertyName - Name of the property
      Returns:
      if the property is a collection