Packages

case class APBOptions(enforceMainAPIContract: Boolean = false, renderOptions: RenderOptions = ..., includeExternalInstancesInJsonSummary: Boolean = true) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. APBOptions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new APBOptions(enforceMainAPIContract: Boolean = false, renderOptions: RenderOptions = ..., includeExternalInstancesInJsonSummary: Boolean = true)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. val enforceMainAPIContract: Boolean
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. val includeExternalInstancesInJsonSummary: Boolean
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. val renderOptions: RenderOptions
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def withEnforceMainAPIContract: APBOptions

    Not enforces that the root main file of an APIContract must be API like document

  20. def withRenderOptions(renderOptions: RenderOptions): APBOptions

    Sets custom RenderOptions used when serializing the project to JSON-LD (e.g.

    Sets custom RenderOptions used when serializing the project to JSON-LD (e.g. to include lexical information)

  21. def withSourceInformation: APBOptions

    Includes lexical position information in the JSON-LD graph (needed for accurate Range/Location in validation results)

  22. def withoutEnforceMainAPIContract: APBOptions

    Enforces that the root main file of an APIContract must be API like document

  23. def withoutExternalInstancesInJsonSummary: APBOptions

    Omits the externalInstances field from the JSON/YAML project summary output.

    Omits the externalInstances field from the JSON/YAML project summary output. Does not affect JSON-LD serialization, which always emits api:externalInstance.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped