com.google.gdata.data.docs

Class ArchiveFailure

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.docs.ArchiveFailure

All Implemented Interfaces:

Extension

public class ArchiveFailure
extends AbstractExtension

Path of the failed document.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension

AbstractExtension.AttributesHandler

Field Summary

Fields inherited from class com.google.gdata.data.AbstractExtension

localName, namespace

Constructor Summary

Constructors

Constructor and Description
ArchiveFailure() Default mutable constructor.
ArchiveFailure(String reason, String value) Immutable constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	consumeAttributes(AttributeHelper helper) Consumes attributes from the attribute helper.
boolean	equals(Object obj)
static ExtensionDescription	getDefaultDescription(boolean required, boolean repeatable) Returns the extension description, specifying whether it is required, and whether it is repeatable.
String	getReason() Returns the reason.
String	getValue() Returns the value.
int	hashCode()
boolean	hasReason() Returns whether it has the reason.
boolean	hasValue() Returns whether it has the value.
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setReason(String reason) Sets the reason.
void	setValue(String value) Sets the value.
String	toString()
protected void	validate() Checks the attributes to see if there are any problems.

Methods inherited from class com.google.gdata.data.AbstractExtension

disableStrictValidation, enableStrictValidation, eq, generate, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, getHandler, isImmutable, isStrictValidation, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ArchiveFailure

public ArchiveFailure()

Default mutable constructor.

ArchiveFailure

public ArchiveFailure(String reason,
              String value)

Immutable constructor.

Parameters:

reason - reason.

value - value.

Method Detail

getReason

public String getReason()

Returns the reason.

Returns:

reason

setReason

public void setReason(String reason)

Sets the reason.

Parameters:

reason - reason or null to reset

hasReason

public boolean hasReason()

Returns whether it has the reason.

Returns:

whether it has the reason

getValue

public String getValue()

Returns the value.

Returns:

value

setValue

public void setValue(String value)

Sets the value.

Parameters:

value - value or null to reset

hasValue

public boolean hasValue()

Returns whether it has the value.

Returns:

whether it has the value

validate

protected void validate()

Description copied from class: AbstractExtension

Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.

Overrides:

validate in class AbstractExtension

getDefaultDescription

public static ExtensionDescription getDefaultDescription(boolean required,
                                         boolean repeatable)

Returns the extension description, specifying whether it is required, and whether it is repeatable.

Parameters:

required - whether it is required

repeatable - whether it is repeatable

Returns:

extension description

putAttributes

protected void putAttributes(AttributeGenerator generator)

Description copied from class: AbstractExtension

Puts attributes into the attribute generator. Called from AbstractExtension.generate(XmlWriter,ExtensionProfile). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Overrides:

putAttributes in class AbstractExtension

Parameters:

generator - attribute generator

consumeAttributes

protected void consumeAttributes(AttributeHelper helper)
                          throws ParseException

Description copied from class: AbstractExtension

Consumes attributes from the attribute helper. May also use AttributeHelper.consumeContent(boolean) to consume the element's text content. Called from AbstractExtension.getHandler(com.google.gdata.data.ExtensionProfile, java.lang.String, java.lang.String, org.xml.sax.Attributes). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Overrides:

consumeAttributes in class AbstractExtension

Parameters:

helper - attribute helper

Throws:

ParseException - any parsing exception

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object