Package gov.niem.tools.api.db.version

Class Version.VersionBuilder<C extends Version,B extends Version.VersionBuilder<C,B>>

java.lang.Object
gov.niem.tools.api.db.base.BaseEntity.BaseEntityBuilder<C,B>
gov.niem.tools.api.db.base.BaseStewardEntity.BaseStewardEntityBuilder<C,B>
gov.niem.tools.api.db.base.BaseModelEntity.BaseModelEntityBuilder<C,B>
gov.niem.tools.api.db.version.Version.VersionBuilder<C,B>
Enclosing class:
Version
public abstract static class Version.VersionBuilder<C extends Version,B extends Version.VersionBuilder<C,B>> extends BaseModelEntity.BaseModelEntityBuilder<C,B>

  • Constructor Details

    • VersionBuilder

      public VersionBuilder()

  • Method Details

    • model

      public B model(Model model)
      Returns:
      this.

    • versionNumber

      public B versionNumber(@NonNull @NonNull String versionNumber)
      A number which identifies a version of a model, such as "5.2" or "1.0.1".
      Returns:
      this.

    • draft

      public B draft(String draft)
      A draft of a version, such as "alpha1" or "rc2".
      Returns:
      this.

    • isPublished

      public B isPublished(boolean isPublished)
      True if a version has been published and the content is to be considered finalized; false otherwise.
      Returns:
      this.

    • isCurrent

      public B isCurrent(boolean isCurrent)
      True if this version of the model is considered the current version; false otherwise.
      Returns:
      this.

    • uri

      public B uri(String uri)
      An URI identifier for a version of a model.
      Returns:
      this.

    • conformanceTargets

      public B conformanceTargets(String conformanceTargets)
      A list of one or more URIs that each represents an IEPD class to which the IEPD claims conformance.
      Returns:
      this.

    • exchangePattern

      public B exchangePattern(String exchangePattern)
      A description of a transactional or design pattern used for this IEPD.
      Returns:
      this.

    • exchangePartners

      public B exchangePartners(String exchangePartners)
      A name of an entity or organization that uses this IEPD.
      Returns:
      this.

    • revised

      public B revised(String revised)
      A date the latest changes to an IEPD were published (i.e., CreationDate of previous version).
      Returns:
      this.

    • status

      public B status(String status)
      A description of the current state of this IEPD in development; may also project future plans for the IEPD.
      Returns:
      this.

    • category

      public B category(Version.Category category)
      A kind of version, such as major or minor.
      Returns:
      this.

    • namespaces

      public B namespaces(Set<Namespace> namespaces)
      A set of namespaces defined by a version of a model.
      Returns:
      this.

    • messageRoots

      public B messageRoots(Set<Property> messageRoots)
      A set of properties that serve as the root or starting point of message instances.
      Returns:
      this.

    • prev

      public B prev(Version prev)
      Corresponding entity mapped from the previous version.
      Returns:
      this.

    • next

      public B next(Version next)
      Corresponding entity mapped from the next version.
      Returns:
      this.

    • niemVersion

      public B niemVersion(Version niemVersion)
      A NIEM version on which this version is based, or itself if this is a NIEM version.
      Returns:
      this.

    • self

      protected abstract B self()
      Specified by:
      self in class BaseModelEntity.BaseModelEntityBuilder<C extends Version,B extends Version.VersionBuilder<C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class BaseModelEntity.BaseModelEntityBuilder<C extends Version,B extends Version.VersionBuilder<C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class BaseModelEntity.BaseModelEntityBuilder<C extends Version,B extends Version.VersionBuilder<C,B>>