Google Data APIs Client Library (1.41.1)



com.google.gdata.data.extensions
Class Im

java.lang.Object
  extended by com.google.gdata.data.AbstractExtension
      extended by com.google.gdata.data.ExtensionPoint
          extended by com.google.gdata.data.extensions.Im
All Implemented Interfaces:
Extension

public class Im
extends ExtensionPoint

Describes an instant messaging address.


Nested Class Summary
static class Im.Protocol
          Im protocol.
static class Im.Rel
          Im type.
 
Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint
ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler
 
Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension
AbstractExtension.AttributesHandler
 
Field Summary
 
Fields inherited from class com.google.gdata.data.ExtensionPoint
xmlBlob
 
Fields inherited from class com.google.gdata.data.AbstractExtension
localName, namespace
 
Constructor Summary
Im()
          Default mutable constructor.
Im(java.lang.String address, java.lang.String label, java.lang.Boolean primary, java.lang.String protocol, java.lang.String rel)
          Immutable constructor.
 
Method Summary
protected  void consumeAttributes(AttributeHelper helper)
          Consumes attributes from the attribute helper.
 boolean equals(java.lang.Object obj)
           
 java.lang.String getAddress()
          Returns the IM address.
static ExtensionDescription getDefaultDescription(boolean required, boolean repeatable)
          Returns the extension description, specifying whether it is required, and whether it is repeatable.
 java.lang.String getLabel()
          Returns the label.
 java.lang.Boolean getPrimary()
          Returns the whether this is the primary instant messaging address.
 java.lang.String getProtocol()
          Returns the im protocol.
 java.lang.String getRel()
          Returns the im type.
 boolean hasAddress()
          Returns whether it has the IM address.
 int hashCode()
           
 boolean hasLabel()
          Returns whether it has the label.
 boolean hasPrimary()
          Returns whether it has the whether this is the primary instant messaging address.
 boolean hasProtocol()
          Returns whether it has the im protocol.
 boolean hasRel()
          Returns whether it has the im type.
protected  void putAttributes(AttributeGenerator generator)
          Puts attributes into the attribute generator.
 void setAddress(java.lang.String address)
          Sets the IM address.
 void setLabel(java.lang.String label)
          Sets the label.
 void setPrimary(java.lang.Boolean primary)
          Sets the whether this is the primary instant messaging address.
 void setProtocol(java.lang.String protocol)
          Sets the im protocol.
 void setRel(java.lang.String rel)
          Sets the im type.
 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.ExtensionPoint
addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, declareExtensions, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getHandler, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild, visitChildren
 
Methods inherited from class com.google.gdata.data.AbstractExtension
disableStrictValidation, enableStrictValidation, eq, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Im

public Im()
Default mutable constructor.


Im

public Im(java.lang.String address,
          java.lang.String label,
          java.lang.Boolean primary,
          java.lang.String protocol,
          java.lang.String rel)
Immutable constructor.

Parameters:
address - IM address.
label - label.
primary - whether this is the primary instant messaging address.
protocol - im protocol.
rel - im type.
Method Detail

getAddress

public java.lang.String getAddress()
Returns the IM address.

Returns:
IM address

setAddress

public void setAddress(java.lang.String address)
Sets the IM address.

Parameters:
address - IM address or null to reset

hasAddress

public boolean hasAddress()
Returns whether it has the IM address.

Returns:
whether it has the IM address

getLabel

public java.lang.String getLabel()
Returns the label.

Returns:
label

setLabel

public void setLabel(java.lang.String label)
Sets the label.

Parameters:
label - label or null to reset

hasLabel

public boolean hasLabel()
Returns whether it has the label.

Returns:
whether it has the label

getPrimary

public java.lang.Boolean getPrimary()
Returns the whether this is the primary instant messaging address.

Returns:
whether this is the primary instant messaging address

setPrimary

public void setPrimary(java.lang.Boolean primary)
Sets the whether this is the primary instant messaging address.

Parameters:
primary - whether this is the primary instant messaging address or null to reset

hasPrimary

public boolean hasPrimary()
Returns whether it has the whether this is the primary instant messaging address.

Returns:
whether it has the whether this is the primary instant messaging address

getProtocol

public java.lang.String getProtocol()
Returns the im protocol.

Returns:
im protocol

setProtocol

public void setProtocol(java.lang.String protocol)
Sets the im protocol.

Parameters:
protocol - im protocol or null to reset

hasProtocol

public boolean hasProtocol()
Returns whether it has the im protocol.

Returns:
whether it has the im protocol

getRel

public java.lang.String getRel()
Returns the im type.

Returns:
im type

setRel

public void setRel(java.lang.String rel)
Sets the im type.

Parameters:
rel - im type or null to reset

hasRel

public boolean hasRel()
Returns whether it has the im type.

Returns:
whether it has the im type

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