public class

BatchInterrupted

extends ExtensionPoint
implements Extension IBatchInterrupted
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.batch.BatchInterrupted

Class Overview

Entry extension for the element <batch:interrupted>, which marks the batch feed as having been aborted.

Summary

Fields
private String content
private ContentType contentType
private int errorCount
private String reason
private int successCount
private int totalCount
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
BatchInterrupted(String reason, int totalCount, int successCount, int errorCount)
Creates and initializes a BatchInterrupted object.
BatchInterrupted()
Creates an empty object.
BatchInterrupted(Throwable cause, int totalCount, int successCount, int errorCount)
Creates and initializes a BatchInterrupted object.
Public Methods
void generate(XmlWriter w, ExtensionProfile extProfile)
Generates an XML representation for batch:interrupted.
String getContent()
Gets this tag content.
ContentType getContentType()
Describe the content of this tag.
static ExtensionDescription getDefaultDescription()
Returns the suggested extension description.
int getErrorCount()
Gets the number of entries that were rejected.
XmlParser.ElementHandler getHandler(ExtensionProfile extProfile, String namespace, String localName, Attributes attrs)
Creates an XML ElementHandler that will initialize the object based on a tag batch:interrupted parsed by the XML parser.
String getReason()
Gets a short message describing what happened.
int getSkippedCount()
Gets the number of entries that were skipped.
int getSuccessCount()
Gets the number of entries that were processed successfully.
int getTotalCount()
Gets the total number of entries read.
void setContent(String content)
Sets this tag content.
void setContentType(ContentType contentType)
Sets the content type for this tag.
[Expand]
Inherited Methods
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension
From interface com.google.gdata.data.batch.IBatchInterrupted

Fields

private String content

private ContentType contentType

private int errorCount

private String reason

private int successCount

private int totalCount

Public Constructors

public BatchInterrupted (String reason, int totalCount, int successCount, int errorCount)

Creates and initializes a BatchInterrupted object.

Parameters
reason Exception that caused batch processing to stop
totalCount Number of entries parsed so far, note that it is to be expected that totalCount >= successCount + errorCount
successCount Number of entries processed successfully so far
errorCount Number of entries rejected so far

public BatchInterrupted ()

Creates an empty object. Usually used in conjuction with getHandler(ExtensionProfile, String, String, Attributes).

public BatchInterrupted (Throwable cause, int totalCount, int successCount, int errorCount)

Creates and initializes a BatchInterrupted object.

Parameters
cause Exception that caused batch processing to stop
totalCount Number of entries parsed so far, note that it is to be expected that totalCount >= successCount + errorCount
successCount Number of entries processed successfully so far
errorCount Number of entries rejected so far

Public Methods

public void generate (XmlWriter w, ExtensionProfile extProfile)

Generates an XML representation for batch:interrupted.

Parameters
w XML writer
extProfile Extension profile
Throws
IOException

public String getContent ()

Gets this tag content. See also getContentType().

Returns
  • the content of the element.

public ContentType getContentType ()

Describe the content of this tag.

Returns
  • the content type.

public static ExtensionDescription getDefaultDescription ()

Returns the suggested extension description.

public int getErrorCount ()

Gets the number of entries that were rejected.

Returns
  • the number of entries which failed.

public XmlParser.ElementHandler getHandler (ExtensionProfile extProfile, String namespace, String localName, Attributes attrs)

Creates an XML ElementHandler that will initialize the object based on a tag batch:interrupted parsed by the XML parser.

Parameters
extProfile Extension profile
namespace Extension namespace
localName Tag name, without the namespace prefix
attrs Attributes of batch:interrupted
Returns
  • a child handler linked to the current object
Throws
ParseException

public String getReason ()

Gets a short message describing what happened.

Returns
  • the reason for the interruption.

public int getSkippedCount ()

Gets the number of entries that were skipped.

Returns
  • the number of skipped entries.

public int getSuccessCount ()

Gets the number of entries that were processed successfully.

Returns
  • number of successfully processed entries.

public int getTotalCount ()

Gets the total number of entries read.

Returns
  • total number of parsed entries.

public void setContent (String content)

Sets this tag content. The type must correspond contentType.

Parameters
content

public void setContentType (ContentType contentType)

Sets the content type for this tag.

Parameters
contentType