Package org.apache.juneau.commons.bean

Class BeanPropertyMeta.Builder

java.lang.Object

org.apache.juneau.commons.bean.BeanPropertyMeta.Builder

Enclosing class:

BeanPropertyMeta

public static class BeanPropertyMeta.Builder
extends Object

BeanPropertyMeta builder class.

Field Summary

Fields

Modifier and Type	Field	Description
List<ClassInfo>	dictionaryClasses
MethodInfo	getter
FieldInfo	innerField
boolean	isUri
String	name
BeanInfo<?>	rawTypeMeta
BiFunction<BeanSession,Object,Object>	readTransform
MethodInfo	setter
Object	swap
BeanInfo<?>	typeMeta
Set<String>	views
BiFunction<BeanSession,Object,Object>	writeTransform

Method Summary

Modifier and Type	Method	Description
BeanPropertyMeta	build()
BeanPropertyMeta.Builder	canRead()	Marks this property as readable.
BeanPropertyMeta.Builder	canWrite()	Marks this property as writable.
BeanPropertyMeta.Builder	delegateFor(BeanPropertyMeta value)	Sets the original bean property that this one is overriding.
BeanPropertyMeta.Builder	overrideValue(Object value)	Sets the overridden value of this bean property.
BeanPropertyMeta.Builder	rawMetaType(Class<?> value)	Sets the raw metadata type for this bean property from a Class.
BeanPropertyMeta.Builder	rawMetaType(BeanInfo<?> value)	Sets the raw metadata type for this bean property.
BeanPropertyMeta.Builder	readTransform(BiFunction<BeanSession,Object,Object> value)	Installs the read-side value transform for this property.
BeanPropertyMeta.Builder	setAsConstructorArg()	Marks this property as a constructor argument.
BeanPropertyMeta.Builder	setExtraKeys(MethodInfo value)	Sets the extra keys method for this bean property.
BeanPropertyMeta.Builder	setField(FieldInfo value)	Sets the field for this bean property.
BeanPropertyMeta.Builder	setGetter(MethodInfo value)	Sets the getter method for this bean property.
BeanPropertyMeta.Builder	setInnerField(FieldInfo value)	Sets the inner field for this bean property from a FieldInfo.
BeanPropertyMeta.Builder	setSetter(MethodInfo value)	Sets the setter method for this bean property.
boolean	validate(BeanTypeResolver bc, TypeVariables typeVarImpls, Set<String> bpro, Set<String> bpwo)	Validates this bean property configuration.
BeanPropertyMeta.Builder	writeTransform(BiFunction<BeanSession,Object,Object> value)	Installs the write-side value transform for this property.

Methods inherited from class java.lang.Object

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

Field Details

name

public String name

innerField

public FieldInfo innerField

getter

public MethodInfo getter

setter

public MethodInfo setter

rawTypeMeta

public BeanInfo<?> rawTypeMeta

swap

public Object swap

readTransform

public BiFunction<BeanSession,Object,Object> readTransform

writeTransform

public BiFunction<BeanSession,Object,Object> writeTransform

dictionaryClasses

public List<ClassInfo> dictionaryClasses

views

public Set<String> views

isUri

public boolean isUri

typeMeta

public BeanInfo<?> typeMeta

Method Details

build

public BeanPropertyMeta build()

Returns:

A new BeanPropertyMeta object using this builder.

delegateFor

public BeanPropertyMeta.Builder delegateFor(BeanPropertyMeta value)

Sets the original bean property that this one is overriding.

Parameters:

value - The original bean property that this one is overriding. Must not be null.

Returns:

This object.

readTransform

public BeanPropertyMeta.Builder readTransform(BiFunction<BeanSession,Object,Object> value)

Installs the read-side value transform for this property.

Applied to the raw getter result by BeanPropertyMeta.get(BeanMap,String) before it is returned to the caller. Defaults to identity (raw value passes through unchanged).

Used by the marshalling layer to install ObjectSwap-aware behavior at bean-meta construction time; the bean-modeling layer itself only invokes the function and does not directly reference ObjectSwap.

Parameters:

value - The transform function. Must not be null.

Returns:

This object.

writeTransform

public BeanPropertyMeta.Builder writeTransform(BiFunction<BeanSession,Object,Object> value)

Installs the write-side value transform for this property.

Applied to the incoming value by BeanPropertyMeta.set(BeanMap,String,Object) before the raw setter is invoked. Defaults to identity (raw value passes through unchanged).

Used by the marshalling layer to install ObjectSwap-aware behavior at bean-meta construction time; the bean-modeling layer itself only invokes the function and does not directly reference ObjectSwap.

Parameters:

value - The transform function. Must not be null.

Returns:

This object.

overrideValue

public BeanPropertyMeta.Builder overrideValue(Object value)

Sets the overridden value of this bean property.

Parameters:

value - The overridden value of this bean property. Can be null, in which case no override is applied.

Returns:

This object.

rawMetaType

public BeanPropertyMeta.Builder rawMetaType(BeanInfo<?> value)

Sets the raw metadata type for this bean property.

Parameters:

value - The raw metadata type for this bean property. Must not be null.

Returns:

This object.

rawMetaType

public BeanPropertyMeta.Builder rawMetaType(Class<?> value)

Sets the raw metadata type for this bean property from a Class.

Convenience overload that resolves the supplied class via the property's BeanTypeResolver, allowing callers from the bean-modeling layer to seed the type without holding a BeanInfo reference.

When the owning BeanMeta was built via the commons-side path (BeanMeta.of(Class, BeanConfigContext)), no resolver is available, so rawTypeMeta/typeMeta are left null and the property runs in raw-reflection mode.

Parameters:

value - The raw metadata type for this bean property. Must not be null.

Returns:

This object.

canRead

public BeanPropertyMeta.Builder canRead()

Marks this property as readable.

Returns:

This object.

canWrite

public BeanPropertyMeta.Builder canWrite()

Marks this property as writable.

Returns:

This object.

setAsConstructorArg

public BeanPropertyMeta.Builder setAsConstructorArg()

Marks this property as a constructor argument.

Returns:

This object.

setExtraKeys

public BeanPropertyMeta.Builder setExtraKeys(MethodInfo value)

Sets the extra keys method for this bean property.

Parameters:

value - The method info that returns extra keys for this property. Must not be null.

Returns:

This object.

setField

public BeanPropertyMeta.Builder setField(FieldInfo value)

Sets the field for this bean property.

Parameters:

value - The field info for this bean property. Must not be null.

Returns:

This object.

setGetter

public BeanPropertyMeta.Builder setGetter(MethodInfo value)

Sets the getter method for this bean property.

Parameters:

value - The getter method info for this bean property. Must not be null.

Returns:

This object.

setInnerField

public BeanPropertyMeta.Builder setInnerField(FieldInfo value)

Sets the inner field for this bean property from a FieldInfo.

Parameters:

value - The field info containing the inner field. Must not be null.

Returns:

This object.

setSetter

public BeanPropertyMeta.Builder setSetter(MethodInfo value)

Sets the setter method for this bean property.

Parameters:

value - The setter method info for this bean property. Must not be null.

Returns:

This object.

validate

public boolean validate(BeanTypeResolver bc,
 TypeVariables typeVarImpls,
 Set<String> bpro,
 Set<String> bpwo)
                 throws Exception

Validates this bean property configuration.

After validation succeeds, marshalling-side callers (currently BeanMeta) read the dictionaryClasses field to construct the property-level registry lookup and store it in a side-map keyed by the built BeanPropertyMeta. The bean-modeling layer itself no longer carries a concrete registry reference.

When bc is null (commons-side path), this method runs in raw-reflection mode: annotation reads are routed through BeanConfigContext.getAnnotationProvider() but no ClassMeta resolution or ObjectSwap discovery is performed; the property's rawTypeMeta/typeMeta stay null and the resulting BeanPropertyMeta exposes raw getter/setter invocation only.

Parameters:

bc - The bean context. May be null for the commons-side path.

typeVarImpls - Type variable implementations. Ignored when bc is null.

bpro - Bean properties read-only set. Must not be null (pass an empty set for none).

bpwo - Bean properties write-only set. Must not be null (pass an empty set for none).

Returns:

true if this property is valid, false otherwise.

Throws:

Exception - If validation fails.