public class

Header

extends ExtensionPoint
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.spreadsheet.Header

Class Overview

Describes a header row.

Summary

Constants
String ROW XML "row" attribute name
String XML_NAME XML element name
Fields
private Integer row Position of the header
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
Header()
Default mutable constructor.
Header(Integer row)
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.
Integer getRow()
Returns the position of the header.
boolean hasRow()
Returns whether it has the position of the header.
int hashCode()
void setRow(Integer row)
Sets the position of the header.
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 ROW

XML "row" attribute name

Constant Value: "row"

static final String XML_NAME

XML element name

Constant Value: "header"

Fields

private Integer row

Position of the header

Public Constructors

public Header ()

Default mutable constructor.

public Header (Integer row)

Immutable constructor.

Parameters
row Position of the header.

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 Integer getRow ()

Returns the position of the header.

Returns
  • position of the header

public boolean hasRow ()

Returns whether it has the position of the header.

Returns
  • whether it has the position of the header

public int hashCode ()

public void setRow (Integer row)

Sets the position of the header.

Parameters
row Position of the header 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.