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.  implicit def bagAsFile(bag: DansBag): File

   Implicit conversion from a nl.knaw.dans.bag.DansBag to a better.files.File.

   Implicit conversion from a nl.knaw.dans.bag.DansBag to a better.files.File. The File pointed to will be the nl.knaw.dans.bag.DansBag#baseDir of the DansBag.

   bag

   the DansBag object representing the bag located at its baseDir

   returns

   the File pointing to the bag's baseDir

6.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... ) @native()

7.  def createFromData(payloadDir: File, algorithms: Set[ChecksumAlgorithm] = Set(ChecksumAlgorithm.SHA1), bagInfo: Map[String, Seq[String]] = Map.empty): Try[DansBag]

   Create a bag based on the payload that is inside payloadDir.

   Create a bag based on the payload that is inside payloadDir. The payload is moved to a subdirectory data/ and from there the bag is created around it. Based on the given algorithms, manifest-<alg>.txt and tagmanifest-<alg>.txt files are created. The manifest-<alg>.txt contain the checksums of the payload files in data/. The tagmanifest-<alg>.txt contain the checksums for bagit.txt, bag-info.txt and all manifest files.

   The resulting bag also a bag-info.txt file with Payload-Oxum, Bagging-Date and all given bagInfo key-value(s) pairs.

   There are no restrictions on the amount of bagInfo entries, apart from the limitations listed in the https://tools.ietf.org/html/draft-kunze-bagit-16 BagIt Spec. There must be at least one algorithm given for the checksums.

   payloadDir

   The directory containing the payload files and in which the bag is created

   algorithms

   The algorithms with which the checksums for the (payload/tag) files are calculated

   bagInfo

   The entries to be added to bag-info.txt

   returns

   if successful, returns a nl.knaw.dans.bag.DansBag object representing the bag located at payloadDir else returns an exception

8.  def empty(baseDir: File, algorithms: Set[ChecksumAlgorithm] = Set(ChecksumAlgorithm.SHA1), bagInfo: Map[String, Seq[String]] = Map.empty): Try[DansBag]

   Create an empty bag at the given baseDir.

   Create an empty bag at the given baseDir. Based on the given algorithms, (empty) manifest-<alg>.txt and (non-empty) tagmanifest-<alg>.txt files are created. The tagmanifest-<alg>.txt contain the checksums for bagit.txt, bag-info.txt and all manifest files. The resulting bag also a bag-info.txt file with Payload-Oxum, Bagging-Date and all given bagInfo key-value(s) pairs.

   There are no restrictions on the amount of bagInfo entries, apart from the limitations listed in the https://tools.ietf.org/html/draft-kunze-bagit-16 BagIt Spec. There must be at least one algorithm given for the checksums.

   baseDir

   The directory in which the bag is created

   algorithms

   The algorithms with which the checksums for the (payload/tag) files are calculated

   bagInfo

   The entries to be added to bag-info.txt

   returns

   if successful, returns a nl.knaw.dans.bag.DansBag object representing the bag located at baseDir else returns an exception

9.  final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

10.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

11.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

13.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

14.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

15.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

16.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

17.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

18.  def read(baseDir: File): Try[DansBag]

    Reads a bag located at baseDir and return a nl.knaw.dans.bag.DansBag when successful.

    Reads a bag located at baseDir and return a nl.knaw.dans.bag.DansBag when successful.

    baseDir

    The directory containing the bag

    returns

    if successful, returns a nl.knaw.dans.bag.DansBag object representing the bag located at baseDir else return an exception

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

    Definition Classes

    AnyRef

20.  def toString(): String

    Definition Classes

    AnyRef → Any

21.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

22.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

23.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... ) @native()