com.google.web.bindery.autobean.shared.impl

Class AbstractAutoBean<T>

java.lang.Object

com.google.web.bindery.autobean.shared.impl.AbstractAutoBean<T>

Type Parameters:

T - the wrapper type

All Implemented Interfaces:

AutoBean<T>, HasSplittable

Direct Known Subclasses:

ProxyAutoBean

public abstract class AbstractAutoBean<T>
extends Object
implements AutoBean<T>, HasSplittable

Basic implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractAutoBean.OneShotContext Used to avoid cycles when visiting.

Nested classes/interfaces inherited from interface com.google.web.bindery.autobean.shared.AutoBean

AutoBean.PropertyName

Field Summary

Fields

Modifier and Type	Field and Description
protected Splittable	data Used by createSimplePeer().
protected static Object[]	EMPTY_OBJECT
static String	UNSPLITTABLE_VALUES_KEY
protected T	wrapped

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAutoBean(AutoBeanFactory factory) Constructor that will use a generated simple peer.
protected	AbstractAutoBean(AutoBeanFactory factory, Splittable data) Constructor that will use a generated simple peer, backed with existing data.
protected	AbstractAutoBean(T wrapped, AutoBeanFactory factory) Constructor that wraps an existing object.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(AutoBeanVisitor visitor) Accept an AutoBeanVisitor.
abstract T	as() Returns a proxy implementation of the T interface which will delegate to the underlying wrapped object, if any.
protected void	call(String method, Object returned, Object... parameters) No-op.
protected void	checkFrozen()
protected void	checkWrapped()
AutoBean<T>	clone(boolean deep) This method always throws an UnsupportedOperationException.
protected T	createSimplePeer()
protected <V> V	get(String method, V toReturn) No-op.
AutoBeanFactory	getFactory() Returns the AutoBeanFactory that created the AutoBean.
protected <W> W	getFromWrapper(W obj)
protected <Q> Q	getOrReify(String propertyName) Native getters and setters for primitive properties are generated for each type to ensure inlining.
Splittable	getSplittable()
<Q> Q	getTag(String tagName) Retrieve a tag value that was previously provided to AutoBean.setTag(String, Object).
protected T	getWrapped()
boolean	hasUnsplittableValues() Indicates that the value returned from getSplittable() may not contain all of the data encapsulated by the AutoBean.
boolean	isFrozen() Returns the value most recently passed to AutoBean.setFrozen(boolean), or false if it has never been called.
protected boolean	isUsingSimplePeer()
protected boolean	isWrapped(Object obj)
boolean	isWrapper() Returns true if the AutoBean was provided with an external object.
protected void	set(String method, Object value) No-op.
void	setData(Splittable data)
void	setFrozen(boolean frozen) Disallows any method calls other than getters.
protected void	setProperty(String propertyName, Object value)
void	setTag(String tagName, Object value) A tag is an arbitrary piece of external metadata to be associated with the wrapped value.
void	traverse(AutoBeanVisitor visitor, AbstractAutoBean.OneShotContext ctx)
protected abstract void	traverseProperties(AutoBeanVisitor visitor, AbstractAutoBean.OneShotContext ctx)
T	unwrap() If the AutoBean wraps an object, return the underlying object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Methods inherited from interface com.google.web.bindery.autobean.shared.AutoBean

getType

Field Detail

UNSPLITTABLE_VALUES_KEY

public static final String UNSPLITTABLE_VALUES_KEY

See Also:

Constant Field Values

EMPTY_OBJECT

protected static final Object[] EMPTY_OBJECT

data

protected Splittable data

Used by createSimplePeer().

wrapped

protected T wrapped

Constructor Detail

AbstractAutoBean

protected AbstractAutoBean(AutoBeanFactory factory)

Constructor that will use a generated simple peer.

AbstractAutoBean

protected AbstractAutoBean(AutoBeanFactory factory,
                Splittable data)

Constructor that will use a generated simple peer, backed with existing data.

AbstractAutoBean

protected AbstractAutoBean(T wrapped,
                AutoBeanFactory factory)

Constructor that wraps an existing object. The parameters on this method are reversed to avoid conflicting with the other two-arg constructor for AutoBean<Splittable> instances.

Method Detail

accept

public void accept(AutoBeanVisitor visitor)

Description copied from interface: AutoBean

Accept an AutoBeanVisitor.

Specified by:

accept in interface AutoBean<T>

Parameters:

visitor - an AutoBeanVisitor

as

public abstract T as()

Description copied from interface: AutoBean

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

Specified by:

as in interface AutoBean<T>

Returns:

a proxy that delegates to the wrapped object

clone

public AutoBean<T> clone(boolean deep)

Description copied from interface: AutoBean

This method always throws an UnsupportedOperationException. The implementation of this method in previous releases was not sufficiently robust and there are no further uses of this method within the GWT code base. Furthermore, there are many different semantics that can be applied to a cloning process that cannot be adequately addressed with a single implementation.

A simple clone of an acyclic datastructure can be created by using AutoBeanCodex to encode and decode the root object. Other cloning algorithms are best implemented by using an AutoBeanVisitor.

Specified by:

clone in interface AutoBean<T>

getFactory

public AutoBeanFactory getFactory()

Description copied from interface: AutoBean

Returns the AutoBeanFactory that created the AutoBean.

Specified by:

getFactory in interface AutoBean<T>

Returns:

an AutoBeanFactory

getSplittable

public Splittable getSplittable()

Specified by:

getSplittable in interface HasSplittable

getTag

public <Q> Q getTag(String tagName)

Description copied from interface: AutoBean

Retrieve a tag value that was previously provided to AutoBean.setTag(String, Object).

Specified by:

getTag in interface AutoBean<T>

Parameters:

tagName - the tag name

Returns:

the tag value

See Also:

AutoBean.setTag(String, Object)

hasUnsplittableValues

public boolean hasUnsplittableValues()

Indicates that the value returned from getSplittable() may not contain all of the data encapsulated by the AutoBean.

isFrozen

public boolean isFrozen()

Description copied from interface: AutoBean

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

Specified by:

isFrozen in interface AutoBean<T>

Returns:

true if this instance is frozen

isWrapper

public boolean isWrapper()

Description copied from interface: AutoBean

Returns true if the AutoBean was provided with an external object.

Specified by:

isWrapper in interface AutoBean<T>

Returns:

true if this instance is a wrapper

setData

public void setData(Splittable data)

setFrozen

public void setFrozen(boolean frozen)

Description copied from interface: AutoBean

Disallows any method calls other than getters. All setter and call operations will throw an IllegalStateException.

Specified by:

setFrozen in interface AutoBean<T>

Parameters:

frozen - if true, freeze this instance

setTag

public void setTag(String tagName,
          Object value)

Description copied from interface: AutoBean

A tag is an arbitrary piece of external metadata to be associated with the wrapped value.

Specified by:

setTag in interface AutoBean<T>

Parameters:

tagName - the tag name

value - the wrapped value

See Also:

AutoBean.getTag(String)

traverse

public void traverse(AutoBeanVisitor visitor,
            AbstractAutoBean.OneShotContext ctx)

unwrap

public T unwrap()

Description copied from interface: AutoBean

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

Specified by:

unwrap in interface AutoBean<T>

Returns:

the previously-wrapped object

call

protected void call(String method,
        Object returned,
        Object... parameters)

No-op. Used as a debugger hook point for generated code.

Parameters:

method - the method name

returned - the returned object

parameters - the parameter list

checkFrozen

protected void checkFrozen()

checkWrapped

protected void checkWrapped()

createSimplePeer

protected T createSimplePeer()

get

protected <V> V get(String method,
        V toReturn)

No-op. Used as a debugger hook point for generated code.

Parameters:

method - the method name

toReturn - the value to return

getFromWrapper

protected <W> W getFromWrapper(W obj)

getOrReify

protected <Q> Q getOrReify(String propertyName)

Native getters and setters for primitive properties are generated for each type to ensure inlining.

getWrapped

protected T getWrapped()

isUsingSimplePeer

protected boolean isUsingSimplePeer()

isWrapped

protected boolean isWrapped(Object obj)

set

protected void set(String method,
       Object value)

No-op. Used as a debugger hook point for generated code.

Parameters:

method - the method name

value - the Object value to be set

setProperty

protected void setProperty(String propertyName,
               Object value)

traverseProperties

protected abstract void traverseProperties(AutoBeanVisitor visitor,
                      AbstractAutoBean.OneShotContext ctx)