GWT 2.1.0

com.google.gwt.editor.client
Interface AutoBean<T>

Type Parameters:
T - the type of interface that will be wrapped.

public interface AutoBean<T>

A controller for an implementation of a bean interface.


Method Summary
 void accept(AutoBeanVisitor visitor)
          Accept an AutoBeanVisitor.
 T as()
          Returns a proxy implementation of the T interface which will delegate to the underlying wrapped object, if any.
 AutoBean<T> clone(boolean deep)
          Creates a copy of the AutoBean.
<Q> Q
getTag(java.lang.String tagName)
          Retrieve a tag value that was previously provided to setTag(String, Object).
 boolean isFrozen()
          Returns the value most recently passed to setFrozen(boolean), or false if it has never been called.
 boolean isWrapper()
          Returns true if the AutoBean was provided with an external object.
 void setFrozen(boolean frozen)
          Disallows any method calls other than getters.
 void setTag(java.lang.String tagName, java.lang.Object value)
          A tag is an arbitrary piece of external metadata to be associated with the wrapped value.
 T unwrap()
          If the AutoBean wraps an object, return the underlying object.
 

Method Detail

accept

void accept(AutoBeanVisitor visitor)
Accept an AutoBeanVisitor.

Parameters:
visitor - an AutoBeanVisitor

as

T as()
Returns a proxy implementation of the T interface which will delegate to the underlying wrapped object, if any.

Returns:
a proxy that delegates to the wrapped object

clone

AutoBean<T> clone(boolean deep)
Creates a copy of the AutoBean.

If the AutoBean has tags, the tags will be copied into the cloned AutoBean. If any of the tag values are AutoBeans, they will not be cloned, regardless of the value of deep.

Parameters:
deep - indicates if all referenced AutoBeans should be cloned
Returns:
a copy of this AutoBean
Throws:
java.lang.IllegalStateException - if the AutoBean is a wrapper type

getTag

<Q> Q getTag(java.lang.String tagName)
Retrieve a tag value that was previously provided to setTag(String, Object).

Parameters:
tagName - the tag name
Returns:
the tag value
See Also:
setTag(String, Object)

isFrozen

boolean isFrozen()
Returns the value most recently passed to setFrozen(boolean), or false if it has never been called.

Returns:
true if this instance is frozen

isWrapper

boolean isWrapper()
Returns true if the AutoBean was provided with an external object.

Returns:
true if this instance is a wrapper

setFrozen

void setFrozen(boolean frozen)
Disallows any method calls other than getters. All setter and call operations will throw an UnsupportedOperationException.

Parameters:
frozen - if true, freeze this instance

setTag

void setTag(java.lang.String tagName,
            java.lang.Object value)
A tag is an arbitrary piece of external metadata to be associated with the wrapped value.

Parameters:
tagName - the tag name
value - the wrapped value
See Also:
getTag(String)

unwrap

T unwrap()
If the AutoBean wraps an object, return the underlying object. The AutoBean will no longer function once unwrapped.

Returns:
the previously-wrapped object
Throws:
java.lang.IllegalStateException - if the AutoBean is not a wrapper

GWT 2.1.0