public class

AdditionalRoleInfo

extends ExtensionPoint
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.docs.AdditionalRoleInfo

Class Overview

A collection of valid additional roles for a document type.

Summary

Constants
String KIND XML "kind" attribute name
String XML_NAME XML element name
Fields
private String kind Kind
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
AdditionalRoleInfo()
Default mutable constructor.
AdditionalRoleInfo(String kind)
Immutable constructor.
Public Methods
void addAdditionalRoleSet(AdditionalRoleSet additionalRoleSet)
Adds a new additional role set.
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.
void setKind(String kind)
Sets the kind.
String toString()
Protected Methods
void consumeAttributes(AttributeHelper helper)
Consumes attributes from the attribute helper.
void putAttributes(AttributeGenerator generator)
Puts attributes into the attribute generator.
void validate()
Checks the attributes to see if there are any problems.
[Expand]
Inherited Methods
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension

Constants

private static final String KIND

XML "kind" attribute name

Constant Value: "kind"

static final String XML_NAME

XML element name

Constant Value: "additionalRoleInfo"

Fields

private String kind

Kind

Public Constructors

public AdditionalRoleInfo ()

Default mutable constructor.

public AdditionalRoleInfo (String kind)

Immutable constructor.

Parameters
kind Kind.

Public Methods

public void addAdditionalRoleSet (AdditionalRoleSet additionalRoleSet)

Adds a new additional role set.

Parameters
additionalRoleSet Additional role set

public void declareExtensions (ExtensionProfile extProfile)

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.

Parameters
extProfile The ExtensionProfile to initialize.

public List<AdditionalRoleSet> getAdditionalRoleSets ()

Returns the additional role sets.

Returns
  • additional role sets

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

public String getKind ()

Returns the kind.

Returns
  • kind

public boolean hasAdditionalRoleSets ()

Returns whether it has the additional role sets.

Returns
  • whether it has the additional role sets

public boolean hasKind ()

Returns whether it has the kind.

Returns
  • whether it has the kind

public void setKind (String kind)

Sets the kind.

Parameters
kind Kind or null to reset

public String toString ()

Protected Methods

protected void consumeAttributes (AttributeHelper helper)

Consumes attributes from the attribute helper. May also use consumeContent(boolean) to consume the element's text content. Called from getHandler(ExtensionProfile, String, String, Attributes). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Parameters
helper Attribute helper
Throws
ParseException

protected void putAttributes (AttributeGenerator generator)

Puts attributes into the attribute generator. Called from generate(XmlWriter, ExtensionProfile). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Parameters
generator Attribute generator

protected void validate ()

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.