com.google.gdata.data.docs

Class AdditionalRoleSet

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.docs.AdditionalRoleSet

All Implemented Interfaces:

Extension

public class AdditionalRoleSet
extends ExtensionPoint

A set of valid additional roles for a primary role within 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
AdditionalRoleSet() Default mutable constructor.
AdditionalRoleSet(String primaryRole) Immutable constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAdditionalRole(AdditionalRole additionalRole) Adds a new additional role.
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<AdditionalRole>	getAdditionalRoles() Returns the additional roles.
static ExtensionDescription	getDefaultDescription(boolean required, boolean repeatable) Returns the extension description, specifying whether it is required, and whether it is repeatable.
String	getPrimaryRole() Returns the primaryRole.
boolean	hasAdditionalRoles() Returns whether it has the additional roles.
boolean	hasPrimaryRole() Returns whether it has the primaryRole.
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setPrimaryRole(String primaryRole) Sets the primaryRole.
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

AdditionalRoleSet

public AdditionalRoleSet()

Default mutable constructor.

AdditionalRoleSet

public AdditionalRoleSet(String primaryRole)

Immutable constructor.

Parameters:

primaryRole - primaryRole.

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.

getAdditionalRoles

public List<AdditionalRole> getAdditionalRoles()

Returns the additional roles.

Returns:

additional roles

addAdditionalRole

public void addAdditionalRole(AdditionalRole additionalRole)

Adds a new additional role.

Parameters:

additionalRole - additional role

hasAdditionalRoles

public boolean hasAdditionalRoles()

Returns whether it has the additional roles.

Returns:

whether it has the additional roles

getPrimaryRole

public String getPrimaryRole()

Returns the primaryRole.

Returns:

primaryRole

setPrimaryRole

public void setPrimaryRole(String primaryRole)

Sets the primaryRole.

Parameters:

primaryRole - primaryRole or null to reset

hasPrimaryRole

public boolean hasPrimaryRole()

Returns whether it has the primaryRole.

Returns:

whether it has the primaryRole

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