Google Data APIs Client Library (1.41.1)



com.google.gdata.data.spreadsheet
Class Column

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

public class Column
extends ExtensionPoint

Describes a column.


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
 
Fields inherited from class com.google.gdata.data.ExtensionPoint
xmlBlob
 
Fields inherited from class com.google.gdata.data.AbstractExtension
localName, namespace
 
Constructor Summary
Column()
          Default mutable constructor.
Column(java.lang.String index, java.lang.String name)
          Immutable constructor.
 
Method Summary
protected  void consumeAttributes(AttributeHelper helper)
          Consumes attributes from the attribute helper.
 boolean equals(java.lang.Object obj)
           
static ExtensionDescription getDefaultDescription(boolean required, boolean repeatable)
          Returns the extension description, specifying whether it is required, and whether it is repeatable.
 java.lang.String getIndex()
          Returns the letter(s) or integer position of the column.
 java.lang.String getName()
          Returns the user defined name of the column.
 int hashCode()
           
 boolean hasIndex()
          Returns whether it has the letter(s) or integer position of the column.
 boolean hasName()
          Returns whether it has the user defined name of the column.
protected  void putAttributes(AttributeGenerator generator)
          Puts attributes into the attribute generator.
 void setIndex(java.lang.String index)
          Sets the letter(s) or integer position of the column.
 void setName(java.lang.String name)
          Sets the user defined name of the column.
 java.lang.String toString()
           
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, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Column

public Column()
Default mutable constructor.


Column

public Column(java.lang.String index,
              java.lang.String name)
Immutable constructor.

Parameters:
index - letter(s) or integer position of the column.
name - user defined name of the column.
Method Detail

getIndex

public java.lang.String getIndex()
Returns the letter(s) or integer position of the column.

Returns:
letter(s) or integer position of the column

setIndex

public void setIndex(java.lang.String index)
Sets the letter(s) or integer position of the column.

Parameters:
index - letter(s) or integer position of the column or null to reset

hasIndex

public boolean hasIndex()
Returns whether it has the letter(s) or integer position of the column.

Returns:
whether it has the letter(s) or integer position of the column

getName

public java.lang.String getName()
Returns the user defined name of the column.

Returns:
user defined name of the column

setName

public void setName(java.lang.String name)
Sets the user defined name of the column.

Parameters:
name - user defined name of the column or null to reset

hasName

public boolean hasName()
Returns whether it has the user defined name of the column.

Returns:
whether it has the user defined name of the column

validate

protected void validate()
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

getDefaultDescription

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

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

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object