com.google.gdata.data.acl
Class AclWithKey

java.lang.Object
  com.google.gdata.data.AbstractExtension
      com.google.gdata.data.ExtensionPoint
          com.google.gdata.data.acl.AclWithKey

All Implemented Interfaces:

Extension

public class AclWithKey
extends ExtensionPoint

Describes the key granting a role in an access control list.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint

ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler

Constructor Summary

AclWithKey()
Default mutable constructor.

AclWithKey(java.lang.String key, AclRole role)
Immutable constructor.

Method Summary

void	declareExtensions(ExtensionProfile extProfile) Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
java.lang.String	getKey() Returns the key granting a role.
AclRole	getRole() Returns the role.
boolean	hasKey() Returns whether it has a key.
boolean	hasRole() Returns whether it has the role.
void	setKey(java.lang.String key) Sets the key granting a role.
void	setRole(AclRole role) Sets the role.
java.lang.String	toString()

Methods inherited from class com.google.gdata.data.ExtensionPoint

addExtension, addRepeatingExtension, generateCumulativeXmlBlob, getExtension, getExtensions, getHandler, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit

Methods inherited from class com.google.gdata.data.AbstractExtension

disableStrictValidation, enableStrictValidation, generate, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, setImmutable

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AclWithKey

public AclWithKey()

Default mutable constructor.

AclWithKey

public AclWithKey(java.lang.String key,
                  AclRole role)

Immutable constructor.

Parameters:

key - a key granting a role.

role - a role.

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.

getKey

public java.lang.String getKey()

Returns the key granting a role.

Returns:

a key

setKey

public void setKey(java.lang.String key)

Sets the key granting a role.

Parameters:

key - a key or null to reset

hasKey

public boolean hasKey()

Returns whether it has a key.

Returns:

whether it has a key

getRole

public AclRole getRole()

Returns the role.

Returns:

a role

setRole

public void setRole(AclRole role)

Sets the role.

Parameters:

role - the role or null to reset

hasRole

public boolean hasRole()

Returns whether it has the role.

Returns:

whether it has the role

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object