# DumpArchiveSummary (Apache Commons Compress 1.13 API)

org.apache.commons.compress.archivers.dump

## Class DumpArchiveSummary

- java.lang.Object
- - org.apache.commons.compress.archivers.dump.DumpArchiveSummary

-     public class DumpArchiveSummary
      extends Object

  This class represents identifying information about a Dump archive volume. It consists the archive's dump date, label, hostname, device name and possibly last mount point plus the volume's volume id andfirst record number. For the corresponding C structure see the header of `DumpArchiveEntry`.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(Object o)`
    `String` | `getDevname()` Get the device name, e.g., /dev/sda3 or /dev/mapper/vg0-home.
    `Date` | `getDumpDate()` Get the date of this dump.
    `String` | `getFilesystem()` Get the last mountpoint, e.g., /home.
    `int` | `getFirstRecord()` Get the inode of the first record on this volume.
    `int` | `getFlags()` Get the miscellaneous flags.
    `String` | `getHostname()` Get the hostname of the system where the dump was performed.
    `String` | `getLabel()` Get dump label.
    `int` | `getLevel()` Get the level of this dump.
    `int` | `getNTRec()` Get the number of records per tape block.
    `Date` | `getPreviousDumpDate()` Get the date of the previous dump at this level higher.
    `int` | `getVolume()` Get volume (tape) number.
    `int` | `hashCode()`
    `boolean` | `isCompressed()` Is this volume compressed?
    `boolean` | `isExtendedAttributes()` Does this volume cotain extended attributes.
    `boolean` | `isMetaDataOnly()` Does this volume only contain metadata?
    `boolean` | `isNewHeader()` Is this the new header format?
    `boolean` | `isNewInode()` Is this the new inode format?
    `void` | `setDevname(String devname)` Set the device name.
    `void` | `setDumpDate(Date dumpDate)` Set dump date.
    `void` | `setFilesystem(String filesystem)` Set the last mountpoint.
    `void` | `setFirstRecord(int firstrec)` Set the inode of the first record.
    `void` | `setFlags(int flags)` Set the miscellaneous flags.
    `void` | `setHostname(String hostname)` Set the hostname.
    `void` | `setLabel(String label)` Set dump label.
    `void` | `setLevel(int level)` Set level.
    `void` | `setNTRec(int ntrec)` Set the number of records per tape block.
    `void` | `setPreviousDumpDate(Date previousDumpDate)` Set previous dump date.
    `void` | `setVolume(int volume)` Set volume (tape) number.

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### getDumpDate

          public Date getDumpDate()

      Get the date of this dump.
      Returns:
        the date of this dump.

    - #### setDumpDate

          public void setDumpDate(Date dumpDate)

      Set dump date.
      Parameters:
        `dumpDate` - the dump date

    - #### getPreviousDumpDate

          public Date getPreviousDumpDate()

      Get the date of the previous dump at this level higher.
      Returns:
        dumpdate may be null

    - #### setPreviousDumpDate

          public void setPreviousDumpDate(Date previousDumpDate)

      Set previous dump date.
      Parameters:
        `previousDumpDate` - the previous dump dat

    - #### getVolume

          public int getVolume()

      Get volume (tape) number.
      Returns:
        volume (tape) number.

    - #### setVolume

          public void setVolume(int volume)

      Set volume (tape) number.
      Parameters:
        `volume` - the volume number

    - #### getLevel

          public int getLevel()

      Get the level of this dump. This is a number between 0 and 9, inclusive, and a level 0 dump is a complete dump of the partition. For any other dump 'n' this dump contains all files that have changed since the last dump at this level or lower. This is used to support different levels of incremental backups.
      Returns:
        dump level

    - #### setLevel

          public void setLevel(int level)

      Set level.
      Parameters:
        `level` - the level

    - #### getLabel

          public String getLabel()

      Get dump label. This may be autogenerated or it may be specified bu the user.
      Returns:
        dump label

    - #### setLabel

          public void setLabel(String label)

      Set dump label.
      Parameters:
        `label` - the label

    - #### getFilesystem

          public String getFilesystem()

      Get the last mountpoint, e.g., /home.
      Returns:
        last mountpoint

    - #### setFilesystem

          public void setFilesystem(String filesystem)

      Set the last mountpoint.
      Parameters:
        `filesystem` - the last mountpoint

    - #### getDevname

          public String getDevname()

      Get the device name, e.g., /dev/sda3 or /dev/mapper/vg0-home.
      Returns:
        device name

    - #### setDevname

          public void setDevname(String devname)

      Set the device name.
      Parameters:
        `devname` - the device name

    - #### getHostname

          public String getHostname()

      Get the hostname of the system where the dump was performed.
      Returns:
        hostname the host name

    - #### setHostname

          public void setHostname(String hostname)

      Set the hostname.
      Parameters:
        `hostname` - the host name

    - #### getFlags

          public int getFlags()

      Get the miscellaneous flags. See below.
      Returns:
        flags

    - #### setFlags

          public void setFlags(int flags)

      Set the miscellaneous flags.
      Parameters:
        `flags` - flags

    - #### getFirstRecord

          public int getFirstRecord()

      Get the inode of the first record on this volume.
      Returns:
        inode of the first record on this volume.

    - #### setFirstRecord

          public void setFirstRecord(int firstrec)

      Set the inode of the first record.
      Parameters:
        `firstrec` - the first record

    - #### getNTRec

          public int getNTRec()

      Get the number of records per tape block. This is typically between 10 and 32.
      Returns:
        the number of records per tape block

    - #### setNTRec

          public void setNTRec(int ntrec)

      Set the number of records per tape block.
      Parameters:
        `ntrec` - the number of records per tape block

    - #### isNewHeader

          public boolean isNewHeader()

      Is this the new header format? (We do not currently support the old format.)
      Returns:
        true if using new header format

    - #### isNewInode

          public boolean isNewInode()

      Is this the new inode format? (We do not currently support the old format.)
      Returns:
        true if using new inode format

    - #### isCompressed

          public boolean isCompressed()

      Is this volume compressed? N.B., individual blocks may or may not be compressed. The first block is never compressed.
      Returns:
        true if volume is compressed

    - #### isMetaDataOnly

          public boolean isMetaDataOnly()

      Does this volume only contain metadata?
      Returns:
        true if volume only contains meta-data

    - #### isExtendedAttributes

          public boolean isExtendedAttributes()

      Does this volume cotain extended attributes.
      Returns:
        true if volume cotains extended attributes.

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `Object`

Copyright © 2016 The Apache Software Foundation. All rights reserved.