com.google.gdata.data.spreadsheet
Class Field

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

public class Field
extends AbstractExtension

Describes a field.


Constructor Summary
Field()
          Default mutable constructor.
Field(java.lang.String index, java.lang.String name, java.lang.String value)
          Immutable constructor.
 
Method Summary
 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.
 java.lang.String getValue()
          Returns the displayed value of the cell.
 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.
 boolean hasValue()
          Returns whether it has the displayed value of the cell.
 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.
 void setValue(java.lang.String value)
          Sets the displayed value of the cell.
 java.lang.String toString()
           
 
Methods inherited from class com.google.gdata.data.AbstractExtension
disableStrictValidation, enableStrictValidation, generate, getExtensionLocalName, getExtensionNamespace, getHandler, isImmutable, isStrictValidation, setImmutable
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Field

public Field()
Default mutable constructor.


Field

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

Parameters:
index - letter(s) or integer position of the column.
name - user defined name of the column.
value - displayed value of the cell.
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

getValue

public java.lang.String getValue()
Returns the displayed value of the cell.

Returns:
displayed value of the cell

setValue

public void setValue(java.lang.String value)
Sets the displayed value of the cell.

Parameters:
value - displayed value of the cell or null to reset

hasValue

public boolean hasValue()
Returns whether it has the displayed value of the cell.

Returns:
whether it has the displayed value of the cell

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

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