com.google.gdata.data.photos

Class GphotoStarred

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.photos.GphotoStarred

All Implemented Interfaces:

Extension

public class GphotoStarred
extends AbstractExtension

If viewer starred the photo and total number of stars.

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
GphotoStarred() Default mutable constructor.
GphotoStarred(Integer total, Boolean 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.
Integer	getTotal() Returns the number of stars.
Boolean	getValue() Returns the viewer starred photo.
int	hashCode()
boolean	hasTotal() Returns whether it has the number of stars.
boolean	hasValue() Returns whether it has the viewer starred photo.
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setTotal(Integer total) Sets the number of stars.
void	setValue(Boolean value) Sets the viewer starred photo.
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

GphotoStarred

public GphotoStarred()

Default mutable constructor.

GphotoStarred

public GphotoStarred(Integer total,
             Boolean value)

Immutable constructor.

Parameters:

total - number of stars.

value - viewer starred photo.

Method Detail

getTotal

public Integer getTotal()

Returns the number of stars.

Returns:

number of stars

setTotal

public void setTotal(Integer total)

Sets the number of stars.

Parameters:

total - number of stars or null to reset

hasTotal

public boolean hasTotal()

Returns whether it has the number of stars.

Returns:

whether it has the number of stars

getValue

public Boolean getValue()

Returns the viewer starred photo.

Returns:

viewer starred photo

setValue

public void setValue(Boolean value)

Sets the viewer starred photo.

Parameters:

value - viewer starred photo or null to reset

hasValue

public boolean hasValue()

Returns whether it has the viewer starred photo.

Returns:

whether it has the viewer starred photo

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