public class

InReplyTo

extends ExtensionPoint
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.threading.InReplyTo

Class Overview

Indicates that this entry is a response to another resource.

Summary

Constants
String HREF XML "href" attribute name
String REF XML "ref" attribute name
String SOURCE XML "source" attribute name
String TYPE XML "type" attribute name
String XML_NAME XML element name
Fields
private String href IRI that may be used to retrieve a representation of the resource being responded to
private String ref Persistent universally unique identifier of the resource being responded to
private String source IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute
private String type Hint to the client about the media type of the resource identified by the "href" attribute
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
InReplyTo()
Default mutable constructor.
InReplyTo(String href, String ref, String source, String type)
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 getHref()
Returns the IRI that may be used to retrieve a representation of the resource being responded to.
String getRef()
Returns the persistent universally unique identifier of the resource being responded to.
String getSource()
Returns the IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute.
String getType()
Returns the hint to the client about the media type of the resource identified by the "href" attribute.
boolean hasHref()
Returns whether it has the IRI that may be used to retrieve a representation of the resource being responded to.
boolean hasRef()
Returns whether it has the persistent universally unique identifier of the resource being responded to.
boolean hasSource()
Returns whether it has the IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute.
boolean hasType()
Returns whether it has the hint to the client about the media type of the resource identified by the "href" attribute.
int hashCode()
void setHref(String href)
Sets the IRI that may be used to retrieve a representation of the resource being responded to.
void setRef(String ref)
Sets the persistent universally unique identifier of the resource being responded to.
void setSource(String source)
Sets the IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute.
void setType(String type)
Sets the hint to the client about the media type of the resource identified by the "href" attribute.
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 HREF

XML "href" attribute name

Constant Value: "href"

private static final String REF

XML "ref" attribute name

Constant Value: "ref"

private static final String SOURCE

XML "source" attribute name

Constant Value: "source"

private static final String TYPE

XML "type" attribute name

Constant Value: "type"

static final String XML_NAME

XML element name

Constant Value: "in-reply-to"

Fields

private String href

IRI that may be used to retrieve a representation of the resource being responded to

private String ref

Persistent universally unique identifier of the resource being responded to

private String source

IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute

private String type

Hint to the client about the media type of the resource identified by the "href" attribute

Public Constructors

public InReplyTo ()

Default mutable constructor.

public InReplyTo (String href, String ref, String source, String type)

Immutable constructor.

Parameters
href IRI that may be used to retrieve a representation of the resource being responded to.
ref Persistent universally unique identifier of the resource being responded to.
source IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute.
type Hint to the client about the media type of the resource identified by the "href" attribute.

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 getHref ()

Returns the IRI that may be used to retrieve a representation of the resource being responded to.

Returns
  • IRI that may be used to retrieve a representation of the resource being responded to

public String getRef ()

Returns the persistent universally unique identifier of the resource being responded to.

Returns
  • persistent universally unique identifier of the resource being responded to

public String getSource ()

Returns the IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute.

Returns
  • IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute

public String getType ()

Returns the hint to the client about the media type of the resource identified by the "href" attribute.

Returns
  • hint to the client about the media type of the resource identified by the "href" attribute

public boolean hasHref ()

Returns whether it has the IRI that may be used to retrieve a representation of the resource being responded to.

Returns
  • whether it has the IRI that may be used to retrieve a representation of the resource being responded to

public boolean hasRef ()

Returns whether it has the persistent universally unique identifier of the resource being responded to.

Returns
  • whether it has the persistent universally unique identifier of the resource being responded to

public boolean hasSource ()

Returns whether it has the IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute.

Returns
  • whether it has the IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute

public boolean hasType ()

Returns whether it has the hint to the client about the media type of the resource identified by the "href" attribute.

Returns
  • whether it has the hint to the client about the media type of the resource identified by the "href" attribute

public int hashCode ()

public void setHref (String href)

Sets the IRI that may be used to retrieve a representation of the resource being responded to.

Parameters
href IRI that may be used to retrieve a representation of the resource being responded to or null to reset

public void setRef (String ref)

Sets the persistent universally unique identifier of the resource being responded to.

Parameters
ref Persistent universally unique identifier of the resource being responded to or null to reset

public void setSource (String source)

Sets the IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute.

Parameters
source IRI of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute or null to reset

public void setType (String type)

Sets the hint to the client about the media type of the resource identified by the "href" attribute.

Parameters
type Hint to the client about the media type of the resource identified by the "href" attribute 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.