ArchiveEntry (jhdf5 19.04.1 API)

java.lang.Object
- ch.systemsx.cisd.hdf5.h5ar.ArchiveEntry

public final class ArchiveEntry
extends java.lang.Object

An entry of an archive listing.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checksumOK()` Returns `true` if this the checksum of this archive entry has been verified successfully (or if no verification information for the checksum is available).
`java.lang.String`	`describeLink()` Returns a (verbose) string description of this entry, including the (brief) verification status, if available.
`java.lang.String`	`describeLink(boolean verbose)` Returns a string description of this entry, including the (brief) verification status, if available.
`java.lang.String`	`describeLink(boolean verbose, boolean numeric)` Returns a string description of this entry, including the (brief) verification status, if available.
`java.lang.String`	`describeLink(boolean verbose, boolean numeric, boolean includeCheck)` Returns a string description of this entry.
`ArchiveEntryCompleteness`	`getCompleteness()` Returns how complete this entry is.
`int`	`getCrc32()` Returns the CRC32 checksum of this entry, or 0, if this information is not available or if this entry is not a regular file.
`java.lang.String`	`getCrc32Str()` Returns a string representation (using hexadecimal digits) of the CRC32 checksum of this entry, or "00000000", if this information is not available or if this entry is not a regular file.
`int`	`getGid()` Returns the GID of the group owning this archive entry, or -1, if this information is not available.
`java.lang.String`	`getGroup(boolean numeric)` Returns a string representation of the group owning this archive entry, or "?", if this information is not available.
`long`	`getLastModified()` Returns the date and time of last modification of this entry, measured in seconds since the epoch (00:00:00 GMT, January 1, 1970), or -1, if this information is not available.
`java.lang.String`	`getLastModifiedStr()` Returns a string representation of the date and time of last modification of this entry, or "?", if this information is not available.
`java.lang.String`	`getLinkTarget()` Returns the link target.
`ch.systemsx.cisd.base.unix.FileLinkType`	`getLinkType()` Returns the type of this entry.
`java.lang.String`	`getName()` Returns the name of the path this entry.
`java.lang.String`	`getParentPath()` Returns the parent directory of the path of this entry.
`java.lang.String`	`getPath()` Returns the full path of this entry.
`short`	`getPermissions()` Returns the access permissions of this archive entry, or -1, if this information is not available.
`java.lang.String`	`getPermissionsString(boolean numeric)` Returns a string representation of the access permissions of this archive entry, or "?", if this information is not available.
`java.lang.String`	`getRealName()` Returns the name of the path this entry.
`java.lang.String`	`getRealParentPath()` Returns the real parent directory of the path of this entry.
`java.lang.String`	`getRealPath()` Returns the real full path of this entry.
`long`	`getSize()` Returns the size of this entry, if this entry is a regular file, or 0 otherwise.
`java.lang.String`	`getStatus(boolean verbose)` Returns a status string for this entry.
`int`	`getUid()` Returns the UID of the user owning this archive entry, or -1, if this information is not available.
`java.lang.String`	`getUser(boolean numeric)` Returns a string representation of the user owning this archive entry, or "?", if this information is not available.
`int`	`getVerifiedCrc32()` Returns the verified CRC32 checksum of this archive entry, or 0, if this information is not available.
`java.lang.String`	`getVerifiedCrc32Str()` Returns a string representation (using hexadecimal digits) of the verified CRC32 checksum of this entry, or "00000000", if this information is not available or if this entry is not a regular file.
`long`	`getVerifiedLastModified()` Returns the verified date and time of last modification of this entry, measured in seconds since the epoch (00:00:00 GMT, January 1, 1970), or -1, if this information is not available.
`java.lang.String`	`getVerifiedLastModifiedStr()` Returns a string representation of the verified date and time of last modification of this entry, or "?", if this information is not available.
`long`	`getVerifiedSize()` Returns the verified size of this archive entry, or -1, if this information is not available.
`boolean`	`hasChecksum()` Returns `true`, if this archive entry has a CRC32 checksum stored.
`boolean`	`hasLinkTarget()` Returns `true`, if this entry has a meaningful link target.
`boolean`	`hasVerificationInfo()` Returns true, if this entry has verification information on archive integrity.
`boolean`	`isDirectory()` Returns if this entry is of type `FileLinkType.DIRECTORY`.
`boolean`	`isOK()` Returns `true` if this archive entry has been verified successfully (or if no verification information is available).
`boolean`	`isRegularFile()` Returns if this entry is of type `FileLinkType.REGULAR_FILE`.
`boolean`	`isSymLink()` Returns if this entry is of type `FileLinkType.SYMLINK`.
`boolean`	`lastModifiedOK()` Returns `true` if this the last modification date of this archive entry has been verified successfully (or if no verification information for the last modification date is available).
`boolean`	`linkTypeOK()` Returns `true` if this the type of this archive entry has been verified successfully (or if no verification information for the type is available).
`boolean`	`sizeOK()` Returns `true` if this the size of this archive entry has been verified successfully (or if no verification information for the size is available).
`java.lang.String`	`toString()`
`java.lang.String`	`tryGetErrorLine()` Returns the error line saved for this archive entry, or `null`, if no error line is available.
`ch.systemsx.cisd.base.unix.FileLinkType`	`tryGetVerifiedLinkType()` Returns the verified type of this entry, or `null`, if no verification has been performed on this entry.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getPath
```
public java.lang.String getPath()
```
    Returns the full path of this entry.
  - getParentPath
```
public java.lang.String getParentPath()
```
    Returns the parent directory of the path of this entry.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the path this entry.
  - getRealPath
```
public java.lang.String getRealPath()
```
    Returns the real full path of this entry.
    This will be the same as getPath(), except when it originates from a call to IHDF5ArchiveInfoProvider.tryGetResolvedEntry(String, boolean) with keepPath=true where it will be the path of the link target.
  - getRealParentPath
```
public java.lang.String getRealParentPath()
```
    Returns the real parent directory of the path of this entry.
    This will be the same as getPath(), except when it originates from a call to IHDF5ArchiveInfoProvider.tryGetResolvedEntry(String, boolean) with keepPath=true where it will be the parent path of the link target.
  - getRealName
```
public java.lang.String getRealName()
```
    Returns the name of the path this entry.
    This will be the same as getPath(), except when it originates from a call to IHDF5ArchiveInfoProvider.tryGetResolvedEntry(String, boolean) with keepPath=true where it will be the name of the link target.
  - getCompleteness
```
public ArchiveEntryCompleteness getCompleteness()
```
    Returns how complete this entry is.
    ArchiveEntryCompleteness.BASE entries can occur if the archive does not contain valid file attributes, ArchiveEntryCompleteness.LAST_MODIFIED entries can occur if the archive has been created or updated on a non-POSIX (read: Microsoft Windows) machine.
  - getLinkTarget
```
public java.lang.String getLinkTarget()
```
    Returns the link target. May be "?" if the link target has not been readm or if this entry does not represent a link.
    
    See Also:
    
    hasLinkTarget()
  - hasLinkTarget
```
public boolean hasLinkTarget()
```
    Returns true, if this entry has a meaningful link target.
    
    See Also:
    
    getLinkTarget()
  - getLinkType
```
public ch.systemsx.cisd.base.unix.FileLinkType getLinkType()
```
    Returns the type of this entry.
  - isDirectory
```
public boolean isDirectory()
```
    Returns if this entry is of type FileLinkType.DIRECTORY.
  - isSymLink
```
public boolean isSymLink()
```
    Returns if this entry is of type FileLinkType.SYMLINK.
  - isRegularFile
```
public boolean isRegularFile()
```
    Returns if this entry is of type FileLinkType.REGULAR_FILE.
  - getSize
```
public long getSize()
```
    Returns the size of this entry, if this entry is a regular file, or 0 otherwise.
    
    See Also:
    
    isRegularFile()
  - getLastModified
```
public long getLastModified()
```
    Returns the date and time of last modification of this entry, measured in seconds since the epoch (00:00:00 GMT, January 1, 1970), or -1, if this information is not available.
  - getLastModifiedStr
```
public java.lang.String getLastModifiedStr()
```
    Returns a string representation of the date and time of last modification of this entry, or "?", if this information is not available.
  - hasChecksum
```
public boolean hasChecksum()
```
    Returns true, if this archive entry has a CRC32 checksum stored.
  - getCrc32
```
public int getCrc32()
```
    Returns the CRC32 checksum of this entry, or 0, if this information is not available or if this entry is not a regular file.
    
    See Also:
    
    isRegularFile()
  - getCrc32Str
```
public java.lang.String getCrc32Str()
```
    Returns a string representation (using hexadecimal digits) of the CRC32 checksum of this entry, or "00000000", if this information is not available or if this entry is not a regular file.
    
    See Also:
    
    isRegularFile()
  - getUser
```
public java.lang.String getUser(boolean numeric)
```
    Returns a string representation of the user owning this archive entry, or "?", if this information is not available.
    Note that the archive only stores the UID and it is the local system which is used to resolve the UID to a user.
  - getUid
```
public int getUid()
```
    Returns the UID of the user owning this archive entry, or -1, if this information is not available.
  - getGroup
```
public java.lang.String getGroup(boolean numeric)
```
    Returns a string representation of the group owning this archive entry, or "?", if this information is not available.
    Note that the archive only stores the GID and it is the local system which is used to resolve the GID to a group.
  - getGid
```
public int getGid()
```
    Returns the GID of the group owning this archive entry, or -1, if this information is not available.
  - getPermissions
```
public short getPermissions()
```
    Returns the access permissions of this archive entry, or -1, if this information is not available.
  - getPermissionsString
```
public java.lang.String getPermissionsString(boolean numeric)
```
    Returns a string representation of the access permissions of this archive entry, or "?", if this information is not available.
  - tryGetErrorLine
```
public java.lang.String tryGetErrorLine()
```
    Returns the error line saved for this archive entry, or null, if no error line is available. A non-null error line is one indication of a verification error.
    Note that the error line may contain additional information when a verification step has failed on the archive entry.
  - tryGetVerifiedLinkType
```
public ch.systemsx.cisd.base.unix.FileLinkType tryGetVerifiedLinkType()
```
    Returns the verified type of this entry, or null, if no verification has been performed on this entry.
    This information may come from an internal test of the archive (see ListParameters.isTestArchive()) or from a verification of the archive against the filesystem (see VerifyParameters).
  - getVerifiedSize
```
public long getVerifiedSize()
```
    Returns the verified size of this archive entry, or -1, if this information is not available.
  - getVerifiedCrc32
```
public int getVerifiedCrc32()
```
    Returns the verified CRC32 checksum of this archive entry, or 0, if this information is not available.
  - getVerifiedCrc32Str
```
public java.lang.String getVerifiedCrc32Str()
```
    Returns a string representation (using hexadecimal digits) of the verified CRC32 checksum of this entry, or "00000000", if this information is not available or if this entry is not a regular file.
    
    See Also:
    
    isRegularFile()
  - getVerifiedLastModified
```
public long getVerifiedLastModified()
```
    Returns the verified date and time of last modification of this entry, measured in seconds since the epoch (00:00:00 GMT, January 1, 1970), or -1, if this information is not available.
  - getVerifiedLastModifiedStr
```
public java.lang.String getVerifiedLastModifiedStr()
```
    Returns a string representation of the verified date and time of last modification of this entry, or "?", if this information is not available.
  - hasVerificationInfo
```
public boolean hasVerificationInfo()
```
    Returns true, if this entry has verification information on archive integrity.
  - isOK
```
public boolean isOK()
```
    Returns true if this archive entry has been verified successfully (or if no verification information is available).
  - linkTypeOK
```
public boolean linkTypeOK()
```
    Returns true if this the type of this archive entry has been verified successfully (or if no verification information for the type is available).
  - sizeOK
```
public boolean sizeOK()
```
    Returns true if this the size of this archive entry has been verified successfully (or if no verification information for the size is available).
  - lastModifiedOK
```
public boolean lastModifiedOK()
```
    Returns true if this the last modification date of this archive entry has been verified successfully (or if no verification information for the last modification date is available).
  - checksumOK
```
public boolean checksumOK()
```
    Returns true if this the checksum of this archive entry has been verified successfully (or if no verification information for the checksum is available).
  - getStatus
```
public java.lang.String getStatus(boolean verbose)
```
    Returns a status string for this entry.
    Note that the status will always be OK if no verification information is available.
    
    See Also:
    
    hasVerificationInfo()
  - describeLink
```
public java.lang.String describeLink()
```
    Returns a (verbose) string description of this entry, including the (brief) verification status, if available.
  - describeLink
```
public java.lang.String describeLink(boolean verbose)
```
    Returns a string description of this entry, including the (brief) verification status, if available.
    
    Parameters:
    
    verbose - If true, the link description will contain all information available, if false, it will only contain the path information.
  - describeLink
```
public java.lang.String describeLink(boolean verbose,
                                     boolean numeric)
```
    Returns a string description of this entry, including the (brief) verification status, if available.
    
    Parameters:
    
    verbose - If true, the link description will contain all information available, if false, it will only contain the path information.
    
    numeric - If true, file ownership and access permissions will be represented numerically, if false, they will be represented as strings. Only relevant if verbose is true.
  - describeLink
```
public java.lang.String describeLink(boolean verbose,
                                     boolean numeric,
                                     boolean includeCheck)
```
    Returns a string description of this entry.
    
    Parameters:
    
    verbose - If true, the link description will contain all information available, if false, it will only contain the path information.
    
    numeric - If true, file ownership and access permissions will be represented numerically, if false, they will be represented as strings. Only relevant if verbose is true.
    
    includeCheck - If true (and if verification information is available for this entry), add a (brief) verification status string.
    
    See Also:
    
    hasVerificationInfo()
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ArchiveEntry

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getPath

getParentPath

getName

getRealPath

getRealParentPath

getRealName

getCompleteness

getLinkTarget

hasLinkTarget

getLinkType

isDirectory

isSymLink

isRegularFile

getSize

getLastModified

getLastModifiedStr

hasChecksum

getCrc32

getCrc32Str

getUser

getUid

getGroup

getGid

getPermissions

getPermissionsString

tryGetErrorLine

tryGetVerifiedLinkType

getVerifiedSize

getVerifiedCrc32

getVerifiedCrc32Str

getVerifiedLastModified

getVerifiedLastModifiedStr

hasVerificationInfo

isOK

linkTypeOK

sizeOK

lastModifiedOK

checksumOK

getStatus

describeLink

describeLink

describeLink

describeLink

toString