com.google.gdata.data.analytics
Class CustomVariable

java.lang.Object
  com.google.gdata.data.AbstractExtension
      com.google.gdata.data.ExtensionPoint
          com.google.gdata.data.analytics.CustomVariable

All Implemented Interfaces:

Extension

public class CustomVariable
extends ExtensionPoint

Data about a user-defined custom variable.

Nested Class Summary

static class

CustomVariable.Scope Scope.

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

ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler

Constructor Summary

CustomVariable()
Default mutable constructor.

CustomVariable(java.lang.Integer index, java.lang.String name, java.lang.String scope)
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.Integer	getIndex() Returns the index.
java.lang.String	getName() Returns the name.
java.lang.String	getScope() Returns the scope.
int	hashCode()
boolean	hasIndex() Returns whether it has the index.
boolean	hasName() Returns whether it has the name.
boolean	hasScope() Returns whether it has the scope.
void	setIndex(java.lang.Integer index) Sets the index.
void	setName(java.lang.String name) Sets the name.
void	setScope(java.lang.String scope) Sets the scope.
java.lang.String	toString()

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

addExtension, addRepeatingExtension, declareExtensions, generateCumulativeXmlBlob, getExtension, getExtensions, getHandler, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit

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

disableStrictValidation, enableStrictValidation, generate, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, setImmutable

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomVariable

public CustomVariable()

Default mutable constructor.

CustomVariable

public CustomVariable(java.lang.Integer index,
                      java.lang.String name,
                      java.lang.String scope)

Immutable constructor.

Parameters:

index - index.

name - name.

scope - scope.

Method Detail

getIndex

public java.lang.Integer getIndex()

Returns the index.

Returns:

index

setIndex

public void setIndex(java.lang.Integer index)

Sets the index.

Parameters:

index - index or null to reset

hasIndex

public boolean hasIndex()

Returns whether it has the index.

Returns:

whether it has the index

getName

public java.lang.String getName()

Returns the name.

Returns:

name

setName

public void setName(java.lang.String name)

Sets the name.

Parameters:

name - name or null to reset

hasName

public boolean hasName()

Returns whether it has the name.

Returns:

whether it has the name

getScope

public java.lang.String getScope()

Returns the scope.

Returns:

scope

setScope

public void setScope(java.lang.String scope)

Sets the scope.

Parameters:

scope - scope or null to reset

hasScope

public boolean hasScope()

Returns whether it has the scope.

Returns:

whether it has the scope

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