com.microsoft.bingads.v13.bulk

Class BulkFileWriter

java.lang.Object

com.microsoft.bingads.v13.bulk.BulkFileWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class BulkFileWriter
extends Object
implements Closeable

Provides methods to write bulk entities to a file.

Constructor Summary

Constructors

Constructor and Description
BulkFileWriter(BulkObjectWriter bulkObjectWriter) Reserved for internal use.
BulkFileWriter(File filePath) Creates a new instance of this class with the specified file path.
BulkFileWriter(File filePath, DownloadFileType fileFormat) Creates a new instance of this class with the specified file path and file format.
BulkFileWriter(OutputStream outputStream) Creates a new instance of this class with the specified stream.
BulkFileWriter(OutputStream outputStream, DownloadFileType fileFormat) Creates a new instance of this class with the specified stream.

Method Summary

Modifier and Type	Method and Description
void	close()
void	writeEntity(BulkEntity entity) Writes the specified entity to the file.
void	writeEntity(BulkEntity entity, boolean excludeReadonlyData) Writes the specified entity to the file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BulkFileWriter

public BulkFileWriter(File filePath)
               throws IOException

Creates a new instance of this class with the specified file path.

Parameters:

filePath - Path of the bulk file to read

Throws:

IOException

BulkFileWriter

public BulkFileWriter(OutputStream outputStream)
               throws IOException

Creates a new instance of this class with the specified stream.

Parameters:

outputStream - OutputStream to write

Throws:

IOException

BulkFileWriter

public BulkFileWriter(OutputStream outputStream,
                      DownloadFileType fileFormat)
               throws IOException

Creates a new instance of this class with the specified stream.

Parameters:

outputStream - OutputStream to write

Throws:

IOException

BulkFileWriter

public BulkFileWriter(File filePath,
                      DownloadFileType fileFormat)
               throws IOException

Creates a new instance of this class with the specified file path and file format.

Parameters:

filePath - Path of the bulk file to read

fileFormat - Delimiter to separate columns of data by

Throws:

IOException

BulkFileWriter

public BulkFileWriter(BulkObjectWriter bulkObjectWriter)

Reserved for internal use.

Parameters:

bulkObjectWriter - Bulk object writer

Method Detail

writeEntity

public void writeEntity(BulkEntity entity,
                        boolean excludeReadonlyData)
                 throws IOException

Writes the specified entity to the file.

• Single Line Entity: Writes single line to describe content
• Multi Line Entity: Writes lines to describe the entity and all its children

Parameters:

entity - a bulk entity to be written to file

excludeReadonlyData - indicates whether readonly data (such as errors, performance data etc.) should be excluded when writing to file

Throws:

IOException

writeEntity

public void writeEntity(BulkEntity entity)
                 throws IOException

Writes the specified entity to the file.

• Single Line Entity: Writes single line to describe content
• Multi Line Entity: Writes lines to describe the entity and all its children

Parameters:

entity - a bulk entity to be written to file

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException