Package gov.niem.tools.api.db.namespace

Class Namespace.NamespaceBuilder<C extends Namespace,B extends Namespace.NamespaceBuilder<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.base.BaseVersionEntity.BaseVersionEntityBuilder<Namespace,C,B>
gov.niem.tools.api.db.namespace.Namespace.NamespaceBuilder<C,B>
Enclosing class:
Namespace
public abstract static class Namespace.NamespaceBuilder<C extends Namespace,B extends Namespace.NamespaceBuilder<C,B>> extends BaseVersionEntity.BaseVersionEntityBuilder<Namespace,C,B>

  • Constructor Details

    • NamespaceBuilder

      public NamespaceBuilder()

  • Method Details

    • version

      public B version(Version version)
      Model version in which this entity is defined.
      Returns:
      this.

    • prefix

      public B prefix(String prefix)
      A short, non-normative identifier for a namespace.
      Returns:
      this.

    • name

      public B name(String name)
      A name of a namespace.
      Returns:
      this.

    • uri

      public B uri(String uri)
      A normative identifier for a namespace.
      Returns:
      this.

    • definition

      public B definition(String definition)
      A definition that describes a namespace.
      Returns:
      this.

    • category

      public B category(Namespace.Category category)
      A kind of namespace.
      Returns:
      this.

    • draft

      public B draft(String draft)
      A draft version of a namespace. NIEM conventions are to use the value "1" for a namespace that has reached release candidate status or has been published.
      Returns:
      this.

    • target

      public B target(Namespace.NdrTarget target)
      A code representing an NDR conformance target, or null if the namespace is not meant to be conformant.
      Returns:
      this.

    • generation

      public B generation(Namespace.Generation generation)
      A means by which a namespace should be generated.
      • build: Generate by assembling its properties and types
      • static_file: Include it's pre-built file (e.g., externals and utilities)
      • none: Namespace may be referenced but does not need to be included (e.g., XML Schema)
      Defaults to "build".
      Returns:
      this.

    • filename

      public B filename(String filename)
      The filename to use for representations of this namespace such as XML schemas, without a file extension.
      Returns:
      this.

    • filepath

      public B filepath(String filepath)
      The filepath to use for nested representations of this namespace such as for XML schemas, without the filename or extension.
      Returns:
      this.

    • types

      public B types(Set<Type> types)
      Returns:
      this.

    • properties

      public B properties(Set<Property> properties)
      Returns:
      this.

    • self

      protected abstract B self()
      Specified by:
      self in class BaseVersionEntity.BaseVersionEntityBuilder<Namespace,C extends Namespace,B extends Namespace.NamespaceBuilder<C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class BaseVersionEntity.BaseVersionEntityBuilder<Namespace,C extends Namespace,B extends Namespace.NamespaceBuilder<C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class BaseVersionEntity.BaseVersionEntityBuilder<Namespace,C extends Namespace,B extends Namespace.NamespaceBuilder<C,B>>