com.microsoft.bingads.v13.bulk

Class BulkFileReader

java.lang.Object

com.microsoft.bingads.v13.bulk.BulkFileReader

All Implemented Interfaces:

BulkEntityReadable, Closeable, AutoCloseable

public class BulkFileReader
extends Object
implements Closeable, BulkEntityReadable

Provides a method to read bulk entities from a bulk file and make them accessible as an Iterable.

Constructor Summary

Constructors

Constructor and Description
BulkFileReader(BulkRecordReader reader, ResultFileType fileType) Reserved for internal use.
BulkFileReader(File file, ResultFileType resultFileType, DownloadFileType fileFormat) Creates new instance
BulkFileReader(File file, ResultFileType resultFileType, DownloadFileType fileFormat, boolean deleteFileOnClose) Reserved for internal use.
BulkFileReader(InputStream inputStream, ResultFileType resultFileType, DownloadFileType fileFormat) Creates new instance from given stream

Method Summary

Modifier and Type	Method and Description
void	close()
String	getBulkFilePath() Gets bulk file path.
BulkEntityIterable	getEntities() Returns entities stored in the file.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkFileReader

public BulkFileReader(File file,
                      ResultFileType resultFileType,
                      DownloadFileType fileFormat)
               throws IOException

Creates new instance

Parameters:

file - path of the bulk file to read

resultFileType - the type of bulk file download which is being read

fileFormat - the bulk file format

Throws:

IOException

BulkFileReader

public BulkFileReader(File file,
                      ResultFileType resultFileType,
                      DownloadFileType fileFormat,
                      boolean deleteFileOnClose)
               throws IOException

Reserved for internal use.

Parameters:

file - path of the bulk file to read

resultFileType - the type of bulk file download which is being read

fileFormat - the bulk file format

deleteFileOnClose - whether delete the temporary bulk file on close

Throws:

IOException

BulkFileReader

public BulkFileReader(InputStream inputStream,
                      ResultFileType resultFileType,
                      DownloadFileType fileFormat)
               throws IOException

Creates new instance from given stream

Parameters:

inputStream - InputStream to read

resultFileType - the type of bulk file download which is being read

fileFormat - the bulk file format

Throws:

IOException

BulkFileReader

public BulkFileReader(BulkRecordReader reader,
                      ResultFileType fileType)

Reserved for internal use.

Parameters:

reader - the bulk stream reader instance

fileType - the type of bulk file download which is being read

Method Detail

getEntities

public BulkEntityIterable getEntities()

Returns entities stored in the file.

Specified by:

getEntities in interface BulkEntityReadable

Returns:

an iterator over Entities

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getBulkFilePath

public String getBulkFilePath()

Gets bulk file path.