public class

QueryParameter

extends ExtensionPoint
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.docs.QueryParameter

Class Overview

The query that doclist will use.

Summary

Nested Classes
enum QueryParameter.Type Type. 
Constants
String TYPE XML "type" attribute name
String VALUE XML "value" attribute name
String XML_NAME XML element name
Fields
private static final EnumToAttributeValue<QueryParameter.Type> TYPE_ENUM_TO_ATTRIBUTE_VALUE
private QueryParameter.Type type Type
private String value Value
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
QueryParameter()
Default mutable constructor.
QueryParameter(QueryParameter.Type type, 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.
QueryParameter.Type getType()
Returns the type.
String getValue()
Returns the value.
boolean hasType()
Returns whether it has the type.
boolean hasValue()
Returns whether it has the value.
int hashCode()
void setType(QueryParameter.Type type)
Sets the type.
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 TYPE

XML "type" attribute name

Constant Value: "type"

private static final String VALUE

XML "value" attribute name

Constant Value: "value"

static final String XML_NAME

XML element name

Constant Value: "query"

Fields

private static final EnumToAttributeValue<QueryParameter.Type> TYPE_ENUM_TO_ATTRIBUTE_VALUE

private QueryParameter.Type type

Type

private String value

Value

Public Constructors

public QueryParameter ()

Default mutable constructor.

public QueryParameter (QueryParameter.Type type, String value)

Immutable constructor.

Parameters
type Type.
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 QueryParameter.Type getType ()

Returns the type.

Returns
  • type

public String getValue ()

Returns the value.

Returns
  • value

public boolean hasType ()

Returns whether it has the type.

Returns
  • whether it has the type

public boolean hasValue ()

Returns whether it has the value.

Returns
  • whether it has the value

public int hashCode ()

public void setType (QueryParameter.Type type)

Sets the type.

Parameters
type Type 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.