com.google.gdata.model.gd
Class Visibility

java.lang.Object
  com.google.gdata.model.Element
      com.google.gdata.model.gd.Visibility

public class Visibility
extends Element

Describes the base set of values for event visibility. Similar to CLASS in RFC 2445.

Nested Class Summary

static class

Visibility.Value Value.

Field Summary

static ElementKey<java.lang.Void,Visibility>	KEY The key for this element.
static AttributeKey<java.lang.String>	VALUE Value.

Constructor Summary

	Visibility() Constructs an instance using the default key.
protected	Visibility(ElementKey<?,? extends Visibility> key) Subclass constructor, allows subclasses to supply their own element key.
protected	Visibility(ElementKey<?,? extends Visibility> key, Element source) Constructs a new instance by doing a shallow copy of data from an existing Element instance.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getValue() Returns the value.
int	hashCode()
boolean	hasValue() Returns whether it has the value.
Visibility	lock() Locks this element.
static void	registerMetadata(MetadataRegistry registry) Registers the metadata for this element.
Visibility	setValue(java.lang.String value) Sets the value.

Methods inherited from class com.google.gdata.model.Element

adapt, adapt, addElement, addElement, addElement, clear, createElement, createElement, eq, getAttributeCount, getAttributeIterator, getAttributeIterator, getAttributeValue, getAttributeValue, getDefaultKey, getElement, getElement, getElementCount, getElementId, getElementIterator, getElementIterator, getElementKey, getElements, getElements, getElementSet, getElementSet, getElementValue, getElementValue, getTextValue, getTextValue, hasAttribute, hasAttribute, hasElement, hasElement, hasTextValue, isLocked, narrow, removeAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeElement, removeElement, removeElement, removeElement, replaceElement, resolve, resolve, sameClassAs, setAttributeValue, setAttributeValue, setElement, setElement, setElement, setTextValue, toString, validate, visit

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

KEY

public static final ElementKey<java.lang.Void,Visibility> KEY

The key for this element.

VALUE

public static final AttributeKey<java.lang.String> VALUE

Value.

Constructor Detail

Visibility

public Visibility()

Constructs an instance using the default key.

Visibility

protected Visibility(ElementKey<?,? extends Visibility> key)

Subclass constructor, allows subclasses to supply their own element key.

Visibility

protected Visibility(ElementKey<?,? extends Visibility> key,
                     Element source)

Constructs a new instance by doing a shallow copy of data from an existing Element instance. Will use the given ElementKey as the key for the element. This constructor is used when adapting from one element key to another. You cannot call this constructor directly, instead use Element.createElement(ElementKey, Element).

Parameters:

key - The key to use for this element.

source - source element

Method Detail

registerMetadata

public static void registerMetadata(MetadataRegistry registry)

Registers the metadata for this element.

lock

public Visibility lock()

Description copied from class: Element

Locks this element. A locked element cannot have any changes made to its content or its attributes or child elements. This will also lock all attributes and child elements as well. Once this method has been called, this element can be safely published to other threads.

Overrides:

lock in class Element

getValue

public java.lang.String getValue()

Returns the value.

Returns:

value

setValue

public Visibility setValue(java.lang.String value)

Sets the value.

Parameters:

value - value or null to reset

Returns:

this to enable chaining setters

hasValue

public boolean hasValue()

Returns whether it has the value.

Returns:

whether it has the value

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Element

hashCode

public int hashCode()

Overrides:

hashCode in class Element