Google Data APIs Client Library (1.38.0)

com.google.gdata.data.webmastertools
Class Keyword

java.lang.Object
  com.google.gdata.data.AbstractExtension
      com.google.gdata.data.webmastertools.Keyword

All Implemented Interfaces:

Extension

public class Keyword
extends AbstractExtension

A keyword in a site or in a link to a site.

Nested Class Summary

static class

Keyword.Source Source.

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

Keyword()
Default mutable constructor.

Keyword(java.lang.String source, java.lang.String value)
Immutable constructor.

Method Summary

protected void	consumeAttributes(AttributeHelper helper) Consumes attributes from the attribute helper.
boolean	equals(java.lang.Object obj)
static ExtensionDescription	getDefaultDescription(boolean required, boolean repeatable) Returns the extension description, specifying whether it is required, and whether it is repeatable.
java.lang.String	getSource() Returns the source.
java.lang.String	getValue() Returns the value.
int	hashCode()
boolean	hasSource() Returns whether it has the source.
boolean	hasValue() Returns whether it has the value.
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setSource(java.lang.String source) Sets the source.
void	setValue(java.lang.String value) Sets the value.
java.lang.String	toString()
protected void	validate() Checks the attributes to see if there are any problems.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Keyword

public Keyword()

Default mutable constructor.

Keyword

public Keyword(java.lang.String source,
               java.lang.String value)

Immutable constructor.

Parameters:

source - source.

value - value.

Method Detail

getSource

public java.lang.String getSource()

Returns the source.

Returns:

source

setSource

public void setSource(java.lang.String source)

Sets the source.

Parameters:

source - source or null to reset

hasSource

public boolean hasSource()

Returns whether it has the source.

Returns:

whether it has the source

getValue

public java.lang.String getValue()

Returns the value.

Returns:

value

setValue

public void setValue(java.lang.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(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object