Packages

o

com.codedx.util.tool

ZippedToolDataProvider

object ZippedToolDataProvider extends Loggable

Linear Supertypes
Loggable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZippedToolDataProvider
  2. Loggable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait NamingConventions extends AnyRef
    Attributes
    protected
  2. class Reader[DataTypes] extends ToolDataProvider[DataTypes] with NamingConventions
  3. class Writer[DataTypes] extends ToolDataProvider[DataTypes] with NamingConventions

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()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. implicit val logger: Logger
    Attributes
    protected
    Definition Classes
    Loggable
    Annotations
    @transient()
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def reader[DataTypes](zipLocation: File, naming: (DataTypes) ⇒ String)(implicit zfsp: ZfsProviderLike): ToolDataProvider[DataTypes]

    Create a new ToolDataProvider that reads its data from a zip file that was created by a corresponding writer provider.

    Create a new ToolDataProvider that reads its data from a zip file that was created by a corresponding writer provider.

    DataTypes

    The type of "aux" data entries stored in the zip

    zipLocation

    The location of the zip file to read

    naming

    A function used to determine the location of the zip entries corresponding to the "aux" data

  17. def reader(zipLocation: File)(implicit zfsp: ZfsProviderLike): ToolDataProvider[Nothing]

    Create a new ToolDataProvider that reads its data from a zip file that was created by a corresponding writer provider.

    Create a new ToolDataProvider that reads its data from a zip file that was created by a corresponding writer provider.

    zipLocation

    The location of the zip file to read

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. def writer(source: ToolDataProvider[Nothing], zipLocation: File, metadata: Map[String, String] = Map.empty)(implicit zfsp: ZfsProviderLike): ToolDataProvider[Nothing]

    Create a new ToolDataProvider that acts as a proxy to a source provider, saving all loaded data to a zip file for future access.

    Create a new ToolDataProvider that acts as a proxy to a source provider, saving all loaded data to a zip file for future access. When getPrimaryEntries is run for the first time, its data will be saved into the zip. All subsequent times, the data will be read from the saved zip entry.

    To get a ToolDataProvider that can read from the generated zip file, use reader(zipLocation).

    source

    The underlying data provider responsible for loading data

    zipLocation

    The location of the zip file to create

    metadata

    A set of key-value pairs that will be added to a "props" entry in the zip. Defaults to empty

    returns

    A ToolDataProvider that proxies the source and saves its data to the zipLocation

  24. def writerT[DataTypes](source: ToolDataProvider[DataTypes], zipLocation: File, naming: (DataTypes) ⇒ String, metadata: Map[String, String] = Map.empty)(implicit zfsp: ZfsProviderLike): ToolDataProvider[DataTypes]

    Create a new ToolDataProvider that acts as a proxy to a source provider, saving all loaded data to a zip file for future access.

    Create a new ToolDataProvider that acts as a proxy to a source provider, saving all loaded data to a zip file for future access. When getPrimaryEntries is run for the first time, and when get is run for the first time for each respective DataType instance, the loaded data will be saved into the zip. All subsequent times, the data will be read from the saved zip entry.

    To get a ToolDataProvider that can read from the generated zip file, use reader[DataTypes](zipLocation, naming).

    source

    The underlying data provider responsible for loading data

    zipLocation

    The location of the zip file to create

    naming

    A function used to determine the location of the zip entries corresponding to the "aux" data

    metadata

    A set of key-value pairs that will be added to a "props" entry in the zip. Defaults to empty

Inherited from Loggable

Inherited from AnyRef

Inherited from Any

Ungrouped