Google Data APIs Client Library (1.41.1)



com.google.gdata.data.extensions
Class When

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

public class When
extends ExtensionPoint
implements Extension

GData schema extension describing a period of time.


Nested Class Summary
 
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
protected  DateTime endTime
          Event end time (optional).
protected  java.lang.String rel
           
protected  DateTime startTime
          Event start time (required).
protected  java.lang.String valueString
          String description of the event times.
 
Fields inherited from class com.google.gdata.data.ExtensionPoint
xmlBlob
 
Fields inherited from class com.google.gdata.data.AbstractExtension
localName, namespace
 
Constructor Summary
When()
           
 
Method Summary
protected  void consumeAttributes(AttributeHelper helper)
          Consumes attributes from the attribute helper.
static ExtensionDescription getDefaultDescription()
          Returns the suggested extension description and is repeatable.
static ExtensionDescription getDefaultDescription(boolean repeatable)
          Returns the suggested extension description with configurable repeatabilty.
 DateTime getEndTime()
           
 java.lang.String getRel()
           
 DateTime getStartTime()
           
 java.lang.String getValueString()
           
protected  void putAttributes(AttributeGenerator generator)
          Puts attributes into the attribute generator.
 void setEndTime(DateTime v)
           
 void setRel(java.lang.String v)
           
 void setStartTime(DateTime v)
           
 void setValueString(java.lang.String v)
           
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.google.gdata.data.Extension
generate, getHandler
 

Field Detail

rel

protected java.lang.String rel

startTime

protected DateTime startTime
Event start time (required).


endTime

protected DateTime endTime
Event end time (optional).


valueString

protected java.lang.String valueString
String description of the event times.

Constructor Detail

When

public When()
Method Detail

getRel

public java.lang.String getRel()

setRel

public void setRel(java.lang.String v)

getStartTime

public DateTime getStartTime()

setStartTime

public void setStartTime(DateTime v)

getEndTime

public DateTime getEndTime()

setEndTime

public void setEndTime(DateTime v)

getValueString

public java.lang.String getValueString()

setValueString

public void setValueString(java.lang.String v)

getDefaultDescription

public static ExtensionDescription getDefaultDescription(boolean repeatable)
Returns the suggested extension description with configurable repeatabilty.


getDefaultDescription

public static ExtensionDescription getDefaultDescription()
Returns the suggested extension description and is repeatable.


validate

protected void validate()
                 throws java.lang.IllegalStateException
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
Throws:
java.lang.IllegalStateException - if any problems are found with the attributes

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