public class

BatchInterrupted

extends Element
implements IBatchInterrupted
java.lang.Object
   ↳ com.google.gdata.model.Element
     ↳ com.google.gdata.model.batch.BatchInterrupted

Class Overview

Signals that feed processing was interrupted.

Summary

Fields
public static final AttributeKey<ContentType> CONTENT_TYPE The MIME type of the content of this element.
public static final AttributeKey<Integer> ERROR_COUNT The number of entries for which processing failed.
public static final ElementKey<String, BatchInterrupted> KEY The key for this element.
public static final AttributeKey<String> REASON The reason.
public static final AttributeKey<Integer> SKIPPED_COUNT The number of entries parsed but not processed.
public static final AttributeKey<Integer> SUCCESS_COUNT The number of entries processed successfully.
public static final AttributeKey<Integer> TOTAL_COUNT The number of entries that were parsed.
[Expand]
Inherited Fields
From class com.google.gdata.model.Element
Public Constructors
BatchInterrupted()
Default mutable constructor.
BatchInterrupted(String reason, int totalCount, int successCount, int errorCount)
Creates and initializes a BatchInterrupted object.
BatchInterrupted(Throwable cause, int totalCount, int successCount, int errorCount)
Creates and initializes a BatchInterrupted object.
Public Methods
boolean equals(Object obj)
String getContent()
Returns the error message explaining what went wrong while processing the request.
ContentType getContentType()
Returns the MIME type of the content of this element.
int getErrorCount()
Returns the number of entries for which processing failed.
String getReason()
Returns the reason.
int getSkippedCount()
Returns the number of entries parsed but not processed.
int getSuccessCount()
Returns the number of entries processed successfully.
int getTotalCount()
Returns the number of entries that were parsed.
boolean hasContent()
Returns whether it has the error message explaining what went wrong while processing the request.
boolean hasContentType()
Returns whether it has the MIME type of the content of this element.
boolean hasErrorCount()
Returns true if the error count exists.
boolean hasReason()
Returns whether it has the reason.
boolean hasSkippedCount()
Returns whether it has the number of entries parsed but not processed.
boolean hasSuccessCount()
Returns whether it has the number of entries processed successfully.
boolean hasTotalCount()
Returns whether it has the number of entries that were parsed.
int hashCode()
static void registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.
BatchInterrupted setContent(String content)
Sets the error message explaining what went wrong while processing the request.
BatchInterrupted setContentType(ContentType contentType)
Sets the MIME type of the content of this element.
BatchInterrupted setErrorCount(Integer errorCount)
Sets the number of entries for which processing failed.
BatchInterrupted setReason(String reason)
Sets the reason.
BatchInterrupted setSkippedCount(Integer skippedCount)
Sets the number of entries parsed but not processed.
BatchInterrupted setSuccessCount(Integer successCount)
Sets the number of entries processed successfully.
BatchInterrupted setTotalCount(Integer totalCount)
Sets the number of entries that were parsed.
String toString()
[Expand]
Inherited Methods
From class com.google.gdata.model.Element
From class java.lang.Object
From interface com.google.gdata.data.batch.IBatchInterrupted

Fields

public static final AttributeKey<ContentType> CONTENT_TYPE

The MIME type of the content of this element.

public static final AttributeKey<Integer> ERROR_COUNT

The number of entries for which processing failed.

public static final ElementKey<String, BatchInterrupted> KEY

The key for this element.

public static final AttributeKey<String> REASON

The reason.

public static final AttributeKey<Integer> SKIPPED_COUNT

The number of entries parsed but not processed.

public static final AttributeKey<Integer> SUCCESS_COUNT

The number of entries processed successfully.

public static final AttributeKey<Integer> TOTAL_COUNT

The number of entries that were parsed.

Public Constructors

public BatchInterrupted ()

Default mutable constructor.

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
Throws
IllegalArgumentException if the total count is less than successCount - errorCount

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 boolean equals (Object obj)

Parameters
obj

public String getContent ()

Returns the error message explaining what went wrong while processing the request.

Returns
  • error message explaining what went wrong while processing the request

public ContentType getContentType ()

Returns the MIME type of the content of this element.

Returns
  • MIME type of the content of this element

public int getErrorCount ()

Returns the number of entries for which processing failed.

Returns
  • number of entries for which processing failed

public String getReason ()

Returns the reason.

Returns
  • reason

public int getSkippedCount ()

Returns the number of entries parsed but not processed.

Returns
  • number of entries parsed but not processed

public int getSuccessCount ()

Returns the number of entries processed successfully.

Returns
  • number of entries processed successfully

public int getTotalCount ()

Returns the number of entries that were parsed.

Returns
  • number of entries that were parsed

public boolean hasContent ()

Returns whether it has the error message explaining what went wrong while processing the request.

Returns
  • whether it has the error message explaining what went wrong while processing the request

public boolean hasContentType ()

Returns whether it has the MIME type of the content of this element.

Returns
  • whether it has the MIME type of the content of this element

public boolean hasErrorCount ()

Returns true if the error count exists.

public boolean hasReason ()

Returns whether it has the reason.

Returns
  • whether it has the reason

public boolean hasSkippedCount ()

Returns whether it has the number of entries parsed but not processed.

Returns
  • whether it has the number of entries parsed but not processed

public boolean hasSuccessCount ()

Returns whether it has the number of entries processed successfully.

Returns
  • whether it has the number of entries processed successfully

public boolean hasTotalCount ()

Returns whether it has the number of entries that were parsed.

Returns
  • whether it has the number of entries that were parsed

public int hashCode ()

public static void registerMetadata (MetadataRegistry registry)

Registers the metadata for this element.

Parameters
registry

public BatchInterrupted setContent (String content)

Sets the error message explaining what went wrong while processing the request.

Parameters
content Error message explaining what went wrong while processing the request or null to reset

public BatchInterrupted setContentType (ContentType contentType)

Sets the MIME type of the content of this element.

Parameters
contentType MIME type of the content of this element or null to reset

public BatchInterrupted setErrorCount (Integer errorCount)

Sets the number of entries for which processing failed.

Parameters
errorCount Number of entries for which processing failed or null to reset

public BatchInterrupted setReason (String reason)

Sets the reason.

Parameters
reason Reason or null to reset

public BatchInterrupted setSkippedCount (Integer skippedCount)

Sets the number of entries parsed but not processed.

Parameters
skippedCount Number of entries parsed but not processed or null to reset

public BatchInterrupted setSuccessCount (Integer successCount)

Sets the number of entries processed successfully.

Parameters
successCount Number of entries processed successfully or null to reset

public BatchInterrupted setTotalCount (Integer totalCount)

Sets the number of entries that were parsed.

Parameters
totalCount Number of entries that were parsed or null to reset

public String toString ()