Google Data APIs Client Library (1.38.0)

com.google.gdata.data.youtube
Class YtCommentRating

java.lang.Object
  com.google.gdata.data.AbstractExtension
      com.google.gdata.data.youtube.YtCommentRating

All Implemented Interfaces:

Extension

public class YtCommentRating
extends AbstractExtension

Object representation for the yt:commentRating tag. As YouTube does only sum up the votes (-1, 1). Therefore, gd:rating can not be used (min, max range would be required).

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

YtCommentRating()
Creates an empty rating tag.

YtCommentRating(int rating)
Creates a tag and sets the rating.

Method Summary

protected void	consumeAttributes(AttributeHelper helper) Consumes attributes from the attribute helper.
int	getTotal() Gets the sum of all ratings (-1, 1).
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setTotal(int total) Sets the sum of all ratings (-1, 1).

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

eq, generate, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, getHandler, isImmutable, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

YtCommentRating

public YtCommentRating()

Creates an empty rating tag.

YtCommentRating

public YtCommentRating(int rating)

Creates a tag and sets the rating.

Parameters:

rating -

Method Detail

setTotal

public void setTotal(int total)

Sets the sum of all ratings (-1, 1).

getTotal

public int getTotal()

Gets the sum of all ratings (-1, 1).

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