public class

AclScope

extends AbstractExtension
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.acl.AclScope

Class Overview

Describes the scope of an entry in an access control list.

Summary

Nested Classes
enum AclScope.Type predefined values for the "type" attribute  
Constants
String NAME XML "name" attribute name
String SCOPE XML "scope" element name
String TYPE XML "type" attribute name
String VALUE XML "value" attribute name
Fields
private static final LowerCaseEnumToAttributeValue<AclScope.Type> TYPE_ENUM_TO_ATTRIBUTE_VALUE helper to produce lower case name from Type value
private String name name
private AclScope.Type type type
private String value value
[Expand]
Inherited Fields
From class com.google.gdata.data.AbstractExtension
Public Constructors
AclScope()
AclScope(AclScope.Type type, String value)
AclScope(AclScope.Type type, String value, String name)
Public Methods
boolean equals(Object o)
static AclScope fromExternalForm(String externalForm)
Given a standard external representation, return the scope that it represents or null if an invalid representation.
String getName()
AclScope.Type getType()
String getValue()
int hashCode()
void putAttributes(AttributeGenerator generator)
Puts attributes into the attribute generator.
void setName(String name)
void setType(AclScope.Type type)
void setValue(String value)
String toExternalForm()
Return a standard external representation of this scope, suitable for use as an Acl Entry identifier.
String toString()
Protected Methods
void consumeAttributes(AttributeHelper helper)
Consumes attributes from the attribute helper.
void validate()
Checks the attributes to see if there are any problems.
[Expand]
Inherited Methods
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension

Constants

private static final String NAME

XML "name" attribute name

Constant Value: "name"

static final String SCOPE

XML "scope" element name

Constant Value: "scope"

private static final String TYPE

XML "type" attribute name

Constant Value: "type"

private static final String VALUE

XML "value" attribute name

Constant Value: "value"

Fields

private static final LowerCaseEnumToAttributeValue<AclScope.Type> TYPE_ENUM_TO_ATTRIBUTE_VALUE

helper to produce lower case name from Type value

private String name

name

private AclScope.Type type

type

private String value

value

Public Constructors

public AclScope ()

public AclScope (AclScope.Type type, String value)

Parameters
type
value

public AclScope (AclScope.Type type, String value, String name)

Parameters
type
value
name

Public Methods

public boolean equals (Object o)

Parameters
o

public static AclScope fromExternalForm (String externalForm)

Given a standard external representation, return the scope that it represents or null if an invalid representation. This is the inverse operation of toExternalForm.

Parameters
externalForm

public String getName ()

public AclScope.Type getType ()

public String getValue ()

public int hashCode ()

public 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

public void setName (String name)

Parameters
name

public void setType (AclScope.Type type)

Parameters
type

public void setValue (String value)

Parameters
value

public String toExternalForm ()

Return a standard external representation of this scope, suitable for use as an Acl Entry identifier.

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 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.