com.google.gdata.data.spreadsheet

Class Worksheet

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ValueConstruct

com.google.gdata.data.spreadsheet.Worksheet

All Implemented Interfaces:

Extension

public class Worksheet
extends ValueConstruct

Describes a worksheet where the table lives.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension

AbstractExtension.AttributesHandler

Field Summary

Fields inherited from class com.google.gdata.data.ValueConstruct

attrName

Fields inherited from class com.google.gdata.data.AbstractExtension

localName, namespace

Constructor Summary

Constructors

Constructor and Description
Worksheet() Default mutable constructor.
Worksheet(java.lang.String name) Constructor (mutable or immutable).

Method Summary

Methods

Modifier and Type	Method and Description
static ExtensionDescription	getDefaultDescription(boolean required, boolean repeatable) Returns the extension description, specifying whether it is required, and whether it is repeatable.
java.lang.String	getName() Returns the worksheet name.
boolean	hasName() Returns whether it has the worksheet name.
void	setName(java.lang.String name) Sets the worksheet name.
java.lang.String	toString()

Methods inherited from class com.google.gdata.data.ValueConstruct

consumeAttributes, equals, generate, getHandler, getValue, hashCode, hasValue, isRequired, putAttributes, setRequired, setValue

Methods inherited from class com.google.gdata.data.AbstractExtension

disableStrictValidation, enableStrictValidation, eq, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Worksheet

public Worksheet()

Default mutable constructor.

Worksheet

public Worksheet(java.lang.String name)

Constructor (mutable or immutable).

Parameters:

name - immutable worksheet name or null for a mutable worksheet name

Method Detail

getName

public java.lang.String getName()

Returns the worksheet name.

Returns:

worksheet name

setName

public void setName(java.lang.String name)

Sets the worksheet name.

Parameters:

name - worksheet name or null to reset

hasName

public boolean hasName()

Returns whether it has the worksheet name.

Returns:

whether it has the worksheet name

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object