public class

UserDefinedField

extends ExtensionPoint
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.contacts.UserDefinedField

Class Overview

Contact's user defined field.

Summary

Constants
String KEY XML "key" attribute name
String VALUE XML "value" attribute name
String XML_NAME XML element name
Fields
private String key Key
private String value Value
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
UserDefinedField()
Default mutable constructor.
UserDefinedField(String key, 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 getKey()
Returns the key.
String getValue()
Returns the value.
boolean hasKey()
Returns whether it has the key.
boolean hasValue()
Returns whether it has the value.
int hashCode()
void setKey(String key)
Sets the key.
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.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension

Constants

private static final String KEY

XML "key" attribute name

Constant Value: "key"

private static final String VALUE

XML "value" attribute name

Constant Value: "value"

static final String XML_NAME

XML element name

Constant Value: "userDefinedField"

Fields

private String key

Key

private String value

Value

Public Constructors

public UserDefinedField ()

Default mutable constructor.

public UserDefinedField (String key, String value)

Immutable constructor.

Parameters
key Key.
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 getKey ()

Returns the key.

Returns
  • key

public String getValue ()

Returns the value.

Returns
  • value

public boolean hasKey ()

Returns whether it has the key.

Returns
  • whether it has the key

public boolean hasValue ()

Returns whether it has the value.

Returns
  • whether it has the value

public int hashCode ()

public void setKey (String key)

Sets the key.

Parameters
key Key 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.