public class

When

extends ExtensionPoint
implements Extension
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.extensions.When

Class Overview

GData schema extension describing a period of time.

Summary

Constants
String END_TIME XML "endTime" attribute name
String START_TIME XML "startTime" attribute name
String VALUE_STRING XML "valueString" attribute name
String WHEN XML "when" element name
Fields
protected DateTime endTime Event end time (optional).
protected String rel
protected DateTime startTime Event start time (required).
protected String valueString String description of the event times.
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
When()
Public Methods
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()
String getRel()
DateTime getStartTime()
String getValueString()
void setEndTime(DateTime v)
void setRel(String v)
void setStartTime(DateTime v)
void setValueString(String v)
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 END_TIME

XML "endTime" attribute name

Constant Value: "endTime"

private static final String START_TIME

XML "startTime" attribute name

Constant Value: "startTime"

private static final String VALUE_STRING

XML "valueString" attribute name

Constant Value: "valueString"

static final String WHEN

XML "when" element name

Constant Value: "when"

Fields

protected DateTime endTime

Event end time (optional).

protected String rel

protected DateTime startTime

Event start time (required).

protected String valueString

String description of the event times.

Public Constructors

public When ()

Public Methods

public static ExtensionDescription getDefaultDescription ()

Returns the suggested extension description and is repeatable.

public static ExtensionDescription getDefaultDescription (boolean repeatable)

Returns the suggested extension description with configurable repeatabilty.

Parameters
repeatable

public DateTime getEndTime ()

public String getRel ()

public DateTime getStartTime ()

public String getValueString ()

public void setEndTime (DateTime v)

Parameters
v

public void setRel (String v)

Parameters
v

public void setStartTime (DateTime v)

Parameters
v

public void setValueString (String v)

Parameters
v

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.

Throws
IllegalStateException