public class

Keyword

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

Class Overview

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

Summary

Nested Classes
class Keyword.Source Source. 
Constants
String SOURCE XML "source" attribute name
String XML_NAME XML element name
Fields
private String source Source
private String value Value
[Expand]
Inherited Fields
From class com.google.gdata.data.AbstractExtension
Public Constructors
Keyword()
Default mutable constructor.
Keyword(String source, String value)
Immutable constructor.
Public Methods
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 getSource()
Returns the source.
String getValue()
Returns the value.
boolean hasSource()
Returns whether it has the source.
boolean hasValue()
Returns whether it has the value.
int hashCode()
void setSource(String source)
Sets the source.
void setValue(String value)
Sets the value.
String toString()
Protected Methods
void consumeAttributes(AttributeHelper helper)
Consumes attributes from the attribute helper.
void putAttributes(AttributeGenerator generator)
Puts attributes into the attribute generator.
void validate()
Checks the attributes to see if there are any problems.
[Expand]
Inherited Methods
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension

Constants

private static final String SOURCE

XML "source" attribute name

Constant Value: "source"

static final String XML_NAME

XML element name

Constant Value: "keyword"

Fields

private String source

Source

private String value

Value

Public Constructors

public Keyword ()

Default mutable constructor.

public Keyword (String source, String value)

Immutable constructor.

Parameters
source Source.
value Value.

Public Methods

public boolean equals (Object obj)

Parameters
obj

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

public String getSource ()

Returns the source.

Returns
  • source

public String getValue ()

Returns the value.

Returns
  • value

public boolean hasSource ()

Returns whether it has the source.

Returns
  • whether it has the source

public boolean hasValue ()

Returns whether it has the value.

Returns
  • whether it has the value

public int hashCode ()

public void setSource (String source)

Sets the source.

Parameters
source Source or null to reset

public void setValue (String value)

Sets the value.

Parameters
value Value or null to reset

public String toString ()

Protected Methods

protected void consumeAttributes (AttributeHelper helper)

Consumes attributes from the attribute helper. May also use consumeContent(boolean) to consume the element's text content. Called from getHandler(ExtensionProfile, String, String, Attributes). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Parameters
helper Attribute helper
Throws
ParseException

protected void putAttributes (AttributeGenerator generator)

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

Parameters
generator Attribute generator

protected void validate ()

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.