ml.combust.bundle

BundleContext

case class BundleContext[Context](context: Context, format: SerializationFormat, bundleRegistry: BundleRegistry, path: File) extends HasBundleRegistry with Product with Serializable

Class for holding serialization information for a ml.combust.bundle.dsl.Bundle.

This class holds all contextual information for serializing components into Bundle.ML.

Context

extra contextual information specific to implementation

format

desired serialization format (Json, Protobuf, or Mixed)

bundleRegistry

bundle registry of all supported operations

path

path to the Bundle.ML model

Linear Supertypes
Serializable, Serializable, Product, Equals, HasBundleRegistry, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BundleContext
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HasBundleRegistry
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BundleContext(context: Context, format: SerializationFormat, bundleRegistry: BundleRegistry, path: File)

    format

    desired serialization format (Json, Protobuf, or Mixed)

    bundleRegistry

    bundle registry of all supported operations

    path

    path to the Bundle.ML model

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def bundleContext(file: String): BundleContext[Context]

    Create a new bundle context for a subfolder.

    Create a new bundle context for a subfolder.

    file

    name of subfolder

    returns

    bundle context for the subfolder

  8. val bundleRegistry: BundleRegistry

    bundle registry of all supported operations

    bundle registry of all supported operations

    Definition Classes
    BundleContextHasBundleRegistry
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val context: Context

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. def file(name: String): File

    Get a file in the current bundle folder.

    Get a file in the current bundle folder.

    name

    name of the file

    returns

    file in the bundle

  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. val format: SerializationFormat

    desired serialization format (Json, Protobuf, or Mixed)

  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. val path: File

    path to the Bundle.

    path to the Bundle.ML model

  21. def preferredSerializationContext(preferred: ConcreteSerializationFormat): SerializationContext

    Get a concrete serialization format from a preferrece concrete format.

    Get a concrete serialization format from a preferrece concrete format.

    If the Bundle.ML serialization format is Mixed, this will return the preferred concrete format. Otherwise, it will return the Bundle.ML serialization format.

    This method is used to determine how to serialize certain objects that have a preference for serializing to JSON or Protobuf. For instance, a ml.combust.bundle.dsl.Model prefers to be serialized as JSON. However, if the serialization format for the bundle is Protobuf, then it will be serialized as protobuf.

    preferred

    preferred concrete serialization format

    returns

    actual concrete serialization format for object

  22. def serializationContext(concrete: ConcreteSerializationFormat): SerializationContext

    Create a serialization context.

    Create a serialization context.

    Serialization context objects have a concrete serialization format. This concrete format determines how to serialize Bundle.ML components.

    concrete

    actual serialization format for a Bundle.ML component

    returns

    serialization context with bundle registry and concrete serialization format

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HasBundleRegistry

Inherited from AnyRef

Inherited from Any

Ungrouped