|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gdata.data.AbstractExtension
com.google.gdata.data.ExtensionPoint
com.google.gdata.data.analytics.CustomVariable
public class CustomVariable
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.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 |
---|
public CustomVariable()
public CustomVariable(java.lang.Integer index, java.lang.String name, java.lang.String scope)
index
- index.name
- name.scope
- scope.Method Detail |
---|
public java.lang.Integer getIndex()
public void setIndex(java.lang.Integer index)
index
- index or null
to resetpublic boolean hasIndex()
public java.lang.String getName()
public void setName(java.lang.String name)
name
- name or null
to resetpublic boolean hasName()
public java.lang.String getScope()
public void setScope(java.lang.String scope)
scope
- scope or null
to resetpublic boolean hasScope()
protected void validate()
AbstractExtension
validate
in class AbstractExtension
public static ExtensionDescription getDefaultDescription(boolean required, boolean repeatable)
required
- whether it is requiredrepeatable
- whether it is repeatable
protected void putAttributes(AttributeGenerator generator)
AbstractExtension
AbstractExtension.generate(XmlWriter,ExtensionProfile)
. Default implementation
does nothing, though generally this is discouraged unless there really are
no attributes.
putAttributes
in class AbstractExtension
generator
- attribute generatorprotected void consumeAttributes(AttributeHelper helper) throws ParseException
AbstractExtension
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.
consumeAttributes
in class AbstractExtension
helper
- attribute helper
ParseException
- any parsing exceptionpublic boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |