com.google.gdata.data.docs

Class AdditionalRoleInfo

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.docs.AdditionalRoleInfo

All Implemented Interfaces:

Extension

public class AdditionalRoleInfo
extends ExtensionPoint

A collection of valid additional roles for a document type.

Nested Class Summary

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

Constructors

Constructor and Description
AdditionalRoleInfo() Default mutable constructor.
AdditionalRoleInfo(String kind) Immutable constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAdditionalRoleSet(AdditionalRoleSet additionalRoleSet) Adds a new additional role set.
protected void	consumeAttributes(AttributeHelper helper) Consumes attributes from the attribute helper.
void	declareExtensions(ExtensionProfile extProfile) Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
List<AdditionalRoleSet>	getAdditionalRoleSets() Returns the additional role sets.
static ExtensionDescription	getDefaultDescription(boolean required, boolean repeatable) Returns the extension description, specifying whether it is required, and whether it is repeatable.
String	getKind() Returns the kind.
boolean	hasAdditionalRoleSets() Returns whether it has the additional role sets.
boolean	hasKind() Returns whether it has the kind.
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setKind(String kind) Sets the kind.
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, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AdditionalRoleInfo

public AdditionalRoleInfo()

Default mutable constructor.

AdditionalRoleInfo

public AdditionalRoleInfo(String kind)

Immutable constructor.

Parameters:

kind - kind.

Method Detail

declareExtensions

public void declareExtensions(ExtensionProfile extProfile)

Description copied from class: ExtensionPoint

Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. The base implementation does not declare any extensions, but can be overridden by specific types of ExtensionPoints that always contain a well-defined set of extensions.

Overrides:

declareExtensions in class ExtensionPoint

Parameters:

extProfile - the ExtensionProfile to initialize.

getAdditionalRoleSets

public List<AdditionalRoleSet> getAdditionalRoleSets()

Returns the additional role sets.

Returns:

additional role sets

addAdditionalRoleSet

public void addAdditionalRoleSet(AdditionalRoleSet additionalRoleSet)

Adds a new additional role set.

Parameters:

additionalRoleSet - additional role set

hasAdditionalRoleSets

public boolean hasAdditionalRoleSets()

Returns whether it has the additional role sets.

Returns:

whether it has the additional role sets

getKind

public String getKind()

Returns the kind.

Returns:

kind

setKind

public void setKind(String kind)

Sets the kind.

Parameters:

kind - kind or null to reset

hasKind

public boolean hasKind()

Returns whether it has the kind.

Returns:

whether it has the kind

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

toString

public String toString()

Overrides:

toString in class Object