Google Data APIs Client Library (1.41.1)



com.google.gdata.data.analytics
Class CustomVariable

java.lang.Object
  extended by com.google.gdata.data.AbstractExtension
      extended by com.google.gdata.data.ExtensionPoint
          extended by 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
 
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
CustomVariable()
          Default mutable constructor.
CustomVariable(java.lang.Integer index, java.lang.String name, java.lang.String scope)
          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.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.
protected  void putAttributes(AttributeGenerator generator)
          Puts attributes into the attribute generator.
 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()
           
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

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

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