ReportingDescriptor.java

package org.schemastore.json.sarif.x210;

import gov.nist.secauto.metaschema.core.datatype.adapter.StringAdapter;
import gov.nist.secauto.metaschema.core.datatype.adapter.UriAdapter;
import gov.nist.secauto.metaschema.core.datatype.adapter.UuidAdapter;
import gov.nist.secauto.metaschema.core.model.IBoundObject;
import gov.nist.secauto.metaschema.core.model.IMetaschemaData;
import gov.nist.secauto.metaschema.databind.model.annotations.BoundAssembly;
import gov.nist.secauto.metaschema.databind.model.annotations.BoundField;
import gov.nist.secauto.metaschema.databind.model.annotations.BoundFlag;
import gov.nist.secauto.metaschema.databind.model.annotations.MetaschemaAssembly;
import java.lang.Override;
import java.lang.String;
import java.net.URI;
import java.util.UUID;
import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;

/**
 * Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.
 */
@MetaschemaAssembly(
    formalName = "Reporting Descriptor",
    description = "Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.",
    name = "reportingDescriptor",
    moduleClass = SarifModule.class
)
public class ReportingDescriptor implements IBoundObject {
  private final IMetaschemaData __metaschemaData;

  /**
   * "A stable, opaque identifier for the report."
   */
  @BoundFlag(
      formalName = "Reporting Descriptor Identifier",
      description = "A stable, opaque identifier for the report.",
      name = "id",
      required = true,
      typeAdapter = StringAdapter.class
  )
  private String _id;

  /**
   * "A stable, unique identifier for the reporting descriptor."
   */
  @BoundFlag(
      formalName = "Reporting Descriptor Unique Identifier",
      description = "A stable, unique identifier for the reporting descriptor.",
      name = "guid",
      typeAdapter = UuidAdapter.class
  )
  private UUID _guid;

  @BoundField(
      formalName = "Reporting Descriptor Name",
      description = "A report identifier that is understandable to an end user.",
      useName = "name"
  )
  private String _name;

  @BoundAssembly(
      formalName = "Short Description",
      description = "A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.",
      useName = "shortDescription"
  )
  private MultiformatMessageString _shortDescription;

  @BoundAssembly(
      formalName = "Full Description",
      description = "A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.",
      useName = "fullDescription"
  )
  private MultiformatMessageString _fullDescription;

  @BoundField(
      formalName = "Help URI",
      description = "A URI where the primary documentation for the report can be found.",
      useName = "helpUri",
      typeAdapter = UriAdapter.class
  )
  private URI _helpUri;

  @BoundAssembly(
      formalName = "Help Description",
      description = "Provides the primary documentation for the report, useful when there is no online documentation.",
      useName = "help"
  )
  private MultiformatMessageString _help;

  public ReportingDescriptor() {
    this(null);
  }

  public ReportingDescriptor(IMetaschemaData data) {
    this.__metaschemaData = data;
  }

  @Override
  public IMetaschemaData getMetaschemaData() {
    return __metaschemaData;
  }

  public String getId() {
    return _id;
  }

  public void setId(String value) {
    _id = value;
  }

  public UUID getGuid() {
    return _guid;
  }

  public void setGuid(UUID value) {
    _guid = value;
  }

  public String getName() {
    return _name;
  }

  public void setName(String value) {
    _name = value;
  }

  public MultiformatMessageString getShortDescription() {
    return _shortDescription;
  }

  public void setShortDescription(MultiformatMessageString value) {
    _shortDescription = value;
  }

  public MultiformatMessageString getFullDescription() {
    return _fullDescription;
  }

  public void setFullDescription(MultiformatMessageString value) {
    _fullDescription = value;
  }

  public URI getHelpUri() {
    return _helpUri;
  }

  public void setHelpUri(URI value) {
    _helpUri = value;
  }

  public MultiformatMessageString getHelp() {
    return _help;
  }

  public void setHelp(MultiformatMessageString value) {
    _help = value;
  }

  @Override
  public String toString() {
    return new ReflectionToStringBuilder(this, ToStringStyle.MULTI_LINE_STYLE).toString();
  }
}