WarcFileWriter (jwat-warc 1.0.3 API)

java.lang.Object
- org.jwat.warc.WarcFileWriter

```
public class WarcFileWriter
extends Object
```
Simple WARC file writer wrapping some of the trivial code related to writing records. Handles automatic max file size closing and renaming of old file and opening of new file. The preferred workflow is to class nextWriter() and close(). Using open() does not expose a clean internal state.

Author:

nicl

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTIVE_SUFFIX` Suffix used for open files.
`protected int`	`sequenceNr` Current sequence number.
`protected WarcFileWriterConfig`	`warcFileConfig` Overall WARC file writer configuration.
`protected WarcFileNaming`	`warcFileNaming` WARC file naming Configuration.
`Uri`	`warcinfoRecordId` Generated WARC-Info-Record-ID for the current file.
`WarcWriter`	`writer` Current WARC writer.
`protected RandomAccessFile`	`writer_raf` Current random access file.
`protected RandomAccessFileOutputStream`	`writer_rafout` Current random access output stream.
`protected File`	`writerFile` Current WARC file.

Constructor Summary

Constructors
Modifier Constructor and Description

protected WarcFileWriter()
Constructor for internal and unit test use.

Constructors
Modifier	Constructor and Description
`protected`	`WarcFileWriter()` Constructor for internal and unit test use.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close writer and release all resources.
`File`	`getFile()` Returns the current EARC file object.
`int`	`getSequenceNr()` Returns the current sequence number.
`static WarcFileWriter`	`getWarcWriterInstance(WarcFileNaming warcFileNaming, WarcFileWriterConfig warcFileConfig)` Returns a configured WARC file writer.
`WarcWriter`	`getWriter()` Returns the current WARC writer object.
`boolean`	`nextWriter()` Checks to see whether a new file needs to be created.
`void`	`open()` Open new file with active prefix and prepare for writing.

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

- Field Detail
  - ACTIVE_SUFFIX
```
public static final String ACTIVE_SUFFIX
```
    Suffix used for open files.
    
    See Also:
    
    Constant Field Values
  - warcFileConfig
```
protected WarcFileWriterConfig warcFileConfig
```
    Overall WARC file writer configuration.
  - warcFileNaming
```
protected WarcFileNaming warcFileNaming
```
    WARC file naming Configuration.
  - sequenceNr
```
protected int sequenceNr
```
    Current sequence number.
  - writerFile
```
protected File writerFile
```
    Current WARC file.
  - writer_raf
```
protected RandomAccessFile writer_raf
```
    Current random access file.
  - writer_rafout
```
protected RandomAccessFileOutputStream writer_rafout
```
    Current random access output stream.
  - writer
```
public WarcWriter writer
```
    Current WARC writer.
  - warcinfoRecordId
```
public Uri warcinfoRecordId
```
    Generated WARC-Info-Record-ID for the current file.
- Constructor Detail
  - WarcFileWriter
```
protected WarcFileWriter()
```
    Constructor for internal and unit test use.
- Method Detail
  - getWarcWriterInstance
```
public static WarcFileWriter getWarcWriterInstance(WarcFileNaming warcFileNaming,
                                                   WarcFileWriterConfig warcFileConfig)
```
    Returns a configured WARC file writer.
    
    Parameters:
    
    warcFileNaming - WARC file naming configuration
    
    warcFileConfig - overall WARC writer configuration
    
    Returns:
    
    WARC file writer instance using the supplied configuration
  - getSequenceNr
```
public int getSequenceNr()
```
    Returns the current sequence number.
    
    Returns:
    
    the current sequence number
  - getFile
```
public File getFile()
```
    Returns the current EARC file object.
    
    Returns:
    
    current EARC file object
  - getWriter
```
public WarcWriter getWriter()
```
    Returns the current WARC writer object.
    
    Returns:
    
    current WARC writer object
  - open
```
public void open()
          throws IOException
```
    Open new file with active prefix and prepare for writing.
    
    Throws:
    
    IOException - if an I/O exception occurs while opening file
  - nextWriter
```
public boolean nextWriter()
                   throws Exception
```
    Checks to see whether a new file needs to be created. Depending on the configuration this also checks if the max file size has been reached and closes/renames the old file and opens a new one.
    
    Returns:
    
    boolean indicating whether new writer/file was created
    
    Throws:
    
    Exception - if an exception occurs
  - close
```
public void close()
           throws IOException
```
    Close writer and release all resources.
    
    Throws:
    
    IOException - in an I/O exception occurs while closing resources

Class WarcFileWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTIVE_SUFFIX

warcFileConfig

warcFileNaming

sequenceNr

writerFile

writer_raf

writer_rafout

writer

warcinfoRecordId

Constructor Detail

WarcFileWriter

Method Detail

getWarcWriterInstance

getSequenceNr

getFile

getWriter

open

nextWriter

close