Packages

c

fun.mactavish.sevenz4s.creator

ArchiveCreator7Z

final class ArchiveCreator7Z extends AbstractArchiveCreator[ArchiveCreator7Z] with Adapter7Z with SetEncryptHeader[ArchiveCreator7Z] with SetSolid[ArchiveCreator7Z] with SetLevel[ArchiveCreator7Z] with SetMultithreading[ArchiveCreator7Z]

Concrete creator for 7Z archives.

Linear Supertypes
SetMultithreading[ArchiveCreator7Z], SetLevel[ArchiveCreator7Z], SetSolid[ArchiveCreator7Z], SetEncryptHeader[ArchiveCreator7Z], Adapter7Z, AbstractAdapter[CompressionEntry7Z, IOutItem7z], AbstractArchiveCreator[ArchiveCreator7Z], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ArchiveCreator7Z
  2. SetMultithreading
  3. SetLevel
  4. SetSolid
  5. SetEncryptHeader
  6. Adapter7Z
  7. AbstractAdapter
  8. AbstractArchiveCreator
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ArchiveCreator7Z()

Type Members

  1. type TEntry = CompressionEntry7Z
    Attributes
    protected
    Definition Classes
    ArchiveCreator7Z → AbstractArchiveCreator
  2. type TItem = IOutItem7z
    Attributes
    protected
    Definition Classes
    ArchiveCreator7Z → AbstractArchiveCreator

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. def adaptEntryToItem(entry: CompressionEntry7Z, template: IOutItem7z): IOutItem7z

    adaptEntryToItem is an adapter from CompressionEntry to IOutItem, it requires an default instance of IOutItem as a template so that it can work without the knowledge of the construction of it.

    adaptEntryToItem is an adapter from CompressionEntry to IOutItem, it requires an default instance of IOutItem as a template so that it can work without the knowledge of the construction of it.

    entry

    input CompressionEntry for adapting

    template

    an default instance of IOutItem

    returns

    IOutItem whose properties are already set according to entry

    Attributes
    protected
    Definition Classes
    Adapter7Z → AbstractAdapter
  5. def adaptItemToEntry(item: IOutItem7z): CompressionEntry7Z

    adaptItemToEntry is an adapter from IOutItem to CompressionEntry, and unlike adaptEntryToItem, it knows how to construct CompressionEntry, so template isn't required.

    adaptItemToEntry is an adapter from IOutItem to CompressionEntry, and unlike adaptEntryToItem, it knows how to construct CompressionEntry, so template isn't required.

    item

    input IOutItem for adapting

    returns

    CompressionEntry whose properties are already set according to item

    Attributes
    protected
    Definition Classes
    Adapter7Z → AbstractAdapter
  6. val archive: IOutCreateArchive7z
    Attributes
    protected
    Definition Classes
    ArchiveCreator7Z → SetMultithreading → SetLevel → SetSolid → SetEncryptHeader
  7. val archivePrototype: IOutCreateArchive[TItem]

    archivePrototype will be casted to specific type in subclasses so that their features can be enabled.

    archivePrototype will be casted to specific type in subclasses so that their features can be enabled.

    Attributes
    protected
    Definition Classes
    AbstractArchiveCreator
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. def compress(entries: Seq[CompressionEntry7Z]): Unit

    Final stage of the archive creation, it will create an archive with given entries.

    Final stage of the archive creation, it will create an archive with given entries. After this operation, this ArchiveCreator may not be reused.

    entries

    entries in the expected archive to be created.

    Definition Classes
    ArchiveCreator7Z → AbstractArchiveCreator
  11. def compress(entry: TEntry): Unit

    Final stage of the archive creation, it will create an archive with given entry.

    Final stage of the archive creation, it will create an archive with given entry. After this operation, this ArchiveCreator may not be reused.

    entry

    entry in the expected archive to be created.

    Definition Classes
    AbstractArchiveCreator
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. val format: net.sf.sevenzipjbinding.ArchiveFormat

    Subclass override format to specify which format of archive it intends to create.

    Subclass override format to specify which format of archive it intends to create.

    Subclass must make sure format get initialized before this trait, (by early definition, maybe) as archivePrototype will use it during trait initialization.

    Attributes
    protected
    Definition Classes
    ArchiveCreator7Z → AbstractArchiveCreator
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def onEachEnd(f: (Boolean) => Unit): ArchiveCreator7Z

    Provides callback triggered after each solid operation.

    Provides callback triggered after each solid operation.

    Usually, the operation of compression of an nonempty entry is solid, after which this callback gets triggered and supplies a boolean parameter indicating whether this operation is successful.

    Note that directory entry and file entry whose size is zero normally doesn't trigger this callback.

    f

    isSuccessful => Unit

    returns

    creator itself so that method calls can be chained

    Definition Classes
    AbstractArchiveCreator
  22. def onProcess(progressTracker: (Long, Long) => Unit): ArchiveCreator7Z

    Provides callback triggered during compression operation.

    Provides callback triggered during compression operation.

    First parameter of the callback is the number of bytes completed compression, the second one is the total number of bytes to compress. Together, they can describe the progress of compression.

    Note that the time and frequency of this callback's trigger is unknown. And it's only relevant with the bytes to compress, nothing to do with the entries.

    progressTracker

    (completed, total) => Unit

    returns

    creator itself so that method calls can be chained

    Definition Classes
    AbstractArchiveCreator
  23. def setHeaderEncryption(b: Boolean): ArchiveCreator7Z
    Definition Classes
    SetEncryptHeader
  24. def setLevel(compressionLevel: Int): ArchiveCreator7Z
    Definition Classes
    SetLevel
  25. def setPassword(passwd: String): ArchiveCreator7Z

    Sets up password protection for this archive.

    Sets up password protection for this archive.

    passwd

    non-nullable password to set up

    returns

    creator itself so that method calls can be chained

    Definition Classes
    AbstractArchiveCreator
  26. def setSolid(b: Boolean): ArchiveCreator7Z
    Definition Classes
    SetSolid
  27. def setSolidExtension(b: Boolean): ArchiveCreator7Z
    Definition Classes
    SetSolid
  28. def setSolidFiles(i: Int): ArchiveCreator7Z
    Definition Classes
    SetSolid
  29. def setSolidSize(l: Long): ArchiveCreator7Z
    Definition Classes
    SetSolid
  30. def setThreadCount(threadCount: Int): ArchiveCreator7Z
    Definition Classes
    SetMultithreading
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. def towards(dst: Either[Path, OutputStream]): ArchiveCreator7Z

    Set a destination for output archive stream, and you shouldn't reset it afterwards.

    Set a destination for output archive stream, and you shouldn't reset it afterwards. Passing a Path results in creation of a new archive file, and passing an OutputStream will see the flush of stream, in which case we won't close it, you have to close the OutputStream on your own.

    dst

    the destination for output archive stream

    returns

    creator itself so that method calls can be chained

    Definition Classes
    AbstractArchiveCreator
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from SetMultithreading[ArchiveCreator7Z]

Inherited from SetLevel[ArchiveCreator7Z]

Inherited from SetSolid[ArchiveCreator7Z]

Inherited from SetEncryptHeader[ArchiveCreator7Z]

Inherited from Adapter7Z

Inherited from AbstractAdapter[CompressionEntry7Z, IOutItem7z]

Inherited from AbstractArchiveCreator[ArchiveCreator7Z]

Inherited from AnyRef

Inherited from Any

Ungrouped