LogFileMetadata (GCToolKit API 3.7.0 API)

java.lang.Object
- com.microsoft.gctoolkit.io.LogFileMetadata

Direct Known Subclasses:

RotatingLogFileMetadata, SingleLogFileMetadata
```
public abstract class LogFileMetadata
extends Object
```
Meta-data about a FileDataSource.

Constructor Summary

Constructors
Constructor Description

LogFileMetadata(Path path)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract int`	`getNumberOfFiles()`	Return the number of files.
`Path`	`getPath()`
`boolean`	`isDirectory()`	`true` if the file is a directory.
`boolean`	`isGZip()`	`true` if the file is a GZip compressed file.
`boolean`	`isPlainText()`	`true` if the file is a regular file.
`boolean`	`isZip()`	`true` if the file is a Zip compressed file.
`abstract Stream<LogFileSegment>`	`logFiles()`

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

- Constructor Detail
  - LogFileMetadata
```
public LogFileMetadata(Path path)
                throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - getPath
```
public Path getPath()
```
  - logFiles
```
public abstract Stream<LogFileSegment> logFiles()
```
  - getNumberOfFiles
```
public abstract int getNumberOfFiles()
```
    Return the number of files. Useful if the file is a compressed file which may contain multiple entries.
    
    Returns:
    
    The number of files in the file.
  - isZip
```
public boolean isZip()
```
    true if the file is a Zip compressed file.
    
    Returns:
    
    true if the file is a Zip compressed file.
  - isGZip
```
public boolean isGZip()
```
    true if the file is a GZip compressed file.
    
    Returns:
    
    true if the file is a GZip compressed file.
  - isPlainText
```
public boolean isPlainText()
```
    true if the file is a regular file.
    
    Returns:
    
    true if the file is a regular file.
  - isDirectory
```
public boolean isDirectory()
```
    true if the file is a directory.
    
    Returns:
    
    true if the file is a directory.