Package org.apache.juneau.swap

Class BeanInterceptor<T>

java.lang.Object

org.apache.juneau.swap.BeanInterceptor<T>

Type Parameters:

T - The bean type.

Direct Known Subclasses:

BeanInterceptor.Void

public class BeanInterceptor<T>
extends Object

Bean interceptor.

Bean interceptors intercept calls to bean getters and setters to allow them to override values in transit.

Example:

// Interceptor that strips out sensitive information on Address beans. public class AddressInterceptor extends BeanInterceptor<Address> { @Override public Object readProperty(Address bean, String name, Object value) { if ("taxInfo".equals(name)) return "redacted"; return value; } @Override public Object writeProperty(Address bean, String name, Object value) { if ("taxInfo".equals(name) && "redacted".equals(value)) return TaxInfoUtils.lookup(bean.getStreet(), bean.getCity(), bean.getState()); return value; } }

Bean interceptors are registered in the following way:

• @Bean(interceptor)
• BeanContext.Builder.beanInterceptor(Class,Class)

Example:

// Register interceptor on bean class. @Bean(interceptor=AddressInterceptor.class) public class Address { public String getTaxInfo() {...} public void setTaxInfo(String value) {...} }

See Also:

• Swap Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BeanInterceptor.Void	Non-existent bean interceptor.

Field Summary

Fields

Modifier and Type	Field	Description
static final BeanInterceptor<Object>	DEFAULT	Default reusable property filter instance.

Constructor Summary

Constructors

Constructor	Description
BeanInterceptor()

Method Summary

Modifier and Type	Method	Description
Object	readProperty(T bean, String name, Object value)	Property read interceptor.
Object	writeProperty(T bean, String name, Object value)	Property write interceptor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT

public static final BeanInterceptor<Object> DEFAULT

Default reusable property filter instance.

Constructor Details

BeanInterceptor

public BeanInterceptor()

Method Details

readProperty

public Object readProperty(T bean,
 String name,
 Object value)

Property read interceptor.

Subclasses can override this property to convert property values to some other object just before serialization.

Example:

// Address filter that strips out sensitive information. public class AddressInterceptor extends BeanInterceptor<Address> { public Object readProperty(Address bean, String name, Object value) { if ("taxInfo".equals(name)) return "redacted"; return value; } }

Parameters:

bean - The bean from which the property was read.

name - The property name.

value - The value just extracted from calling the bean getter.

Returns:

The value to serialize. Default is just to return the existing value.

writeProperty

public Object writeProperty(T bean,
 String name,
 Object value)

Property write interceptor.

Subclasses can override this property to convert property values to some other object just before calling the bean setter.

Example:

// Address filter that strips out sensitive information. public class AddressInterceptor extends BeanInterceptor<Address> { public Object writeProperty(Address bean, String name, Object value) { if ("taxInfo".equals(name) && "redacted".equals(value)) return TaxInfoUtils.lookup(bean.getStreet(), bean.getCity(), bean.getState()); return value; } }

Parameters:

bean - The bean from which the property was read.

name - The property name.

value - The value just parsed.

Returns:

The value to serialize. Default is just to return the existing value.