Package org.apache.juneau.commons.bean

package org.apache.juneau.commons.bean

Bean-modeling layer for Juneau.

Contains the bean-modeling annotations, runtime types, and SPI seams that describe how Java types map to bean property sets, independent of any marshalling concerns. The marshalling layer (in juneau-marshall) layers serializer / parser / swap behavior on top of these primitives.

Annotations

• @BeanType — marks a class as a bean and configures bean-level options (interface class, stop class, property order, etc.).
• @BeanProp — configures a bean property (name, getter, setter, etc.).
• @BeanCtor — marks a constructor as the bean constructor and names its arguments.
• @BeanIgnore — marks a class, method, field, or constructor as not a bean / not a bean property.
• @BeanConfig — applies bean-modeling settings declaratively at the config-annotation level.
• @Name — alternative property name on a parameter.

Runtime types

• BeanMeta — metadata describing a bean class (properties, constructor, type info).
• BeanPropertyMeta — metadata describing a single bean property.
• BeanMap — Map view of a bean backed by its BeanMeta.
• BeanMapEntry — Map.Entry view of a single bean property.
• BeanPropertyValue — read-side property holder used by consumers that iterate bean properties.
• BeanPropertyConsumer — callback for iterating bean properties without materializing a BeanMap.
• BeanProxyInvocationHandler — InvocationHandler that backs interface-only bean proxies.
• BeanInterceptor — pre/post hooks fired around bean property reads / writes.

SPI seams

• BeanConfigContext — immutable POJO carrying all bean-modeling configuration knobs plus SPI hooks. MarshallingContext (in juneau-marshall) installs the marshalling-side resolver / initializer / post-processor.
• BeanInfo — abstract type-classification surface; ClassMeta extends it on the marshalling side.
• BeanTypeResolver — resolves Type references to BeanInfo instances.
• BeanSession — per-operation session surface (type conversion, sub-bean construction, CharSequence parsing).
• BeanFilter — per-class filter surface; MarshalledFilter implements it.
• BeanRegistryLookup — bean-dictionary lookup surface; BeanRegistry implements it.
• BeanMetaInitializer — hook that lets marshalling-side code augment BeanMeta construction (filter discovery, type-name resolution, bean-registry assembly).
• BeanPropertyPostProcessor — hook that lets marshalling-side code augment BeanPropertyMeta construction (swap / surrogate / format annotation processing).
• Delegate — pluggable delegate-bean marker.
• PropertyNamer — pluggable Java-name to bean-property-name transformer.

Thread safety

Practical thread-safety semantics for primary runtime types and SPI seams in this package:

• Not thread-safe (mutable, no internal synchronization): BeanMap, BeanProxyInvocationHandler, BeanConfigContext.Builder.
• Thread-safe after construction (immutable metadata/value holders): BeanConfigContext, BeanMeta, BeanPropertyMeta, BeanPropertyValue, BeanMapEntry.
• Thread safety depends on implementation/state: BeanSession, BeanFilter, BeanRegistryLookup, BeanMetaInitializer, BeanPropertyPostProcessor, BeanPropertyConsumer, BeanInfo.

Related Packages

Package	Description
org.apache.juneau.commons	Foundational classes and annotations shared across the Juneau Commons libraries.

Class	Description
BasicPropertyNamer	Default property namer.
BeanConfig	Annotation for specifying bean-modeling config properties on REST classes and methods.
BeanConfigAnnotation	Utility classes and methods for the @BeanConfig annotation.
BeanConfigContext	Immutable runtime configuration for the bean-modeling layer.
BeanConfigContext.Builder	Builder for BeanConfigContext.
BeanCtor	Maps constructor arguments to property names on beans with read-only properties.
BeanCtorAnnotation	Utility classes and methods for the @BeanCtor annotation.
BeanCtorAnnotation.Builder	Builder class.
BeanFilter	Bean-modeling SPI seam that exposes the per-class filter surface the bean-runtime types (BeanMeta-equivalent) need without coupling the bean-modeling layer to the marshalling-side MarshalledFilter.
BeanIgnore	Excludes a class, field, method, or constructor from bean introspection.
BeanIgnoreAnnotation	Utility classes and methods for the @BeanIgnore annotation.
BeanIgnoreAnnotation.Builder	Builder class.
BeanInfo<T>	Bean-modeling SPI seam that exposes the type-classification surface the bean-runtime types (BeanMeta-equivalents, BeanPropertyMeta-equivalents, etc.) need without coupling the bean-modeling layer to the marshalling-side ClassMeta.
BeanInterceptor<T>	Bean interceptor.
BeanInterceptor.Void	Non-existent bean interceptor.
BeanMap<T>	Java bean wrapper class.
BeanMapEntry	Represents a single entry in a bean map.
BeanMeta<T>	Encapsulates all access to the properties of a bean class (like a souped-up BeanInfo).
BeanMeta.BeanMetaValue<T>	Represents the result of creating a BeanMeta, including the bean metadata and any reason why it's not a bean.
BeanMetaInitializer	Bean-modeling SPI seam that exposes marshalling-aware BeanMeta construction hooks.
BeanProp	Annotation that can be applied to bean fields, getter/setter methods, and constructor parameters to control bean introspection and property modeling.
BeanPropAnnotation	Utility classes and methods for the @BeanProp annotation.
BeanPropAnnotation.Builder	Builder class.
BeanPropertyConsumer	Represents a consumer of a single bean property value.
BeanPropertyMeta	Contains metadata about a bean property.
BeanPropertyMeta.Builder	BeanPropertyMeta builder class.
BeanPropertyPostProcessor	Bean-modeling SPI seam that applies marshalling-side post-processing to a BeanPropertyMeta.Builder after BeanPropertyMeta.Builder#validate() succeeds.
BeanPropertyValue	Represents a simple bean property value and the meta-data associated with it.
BeanProxyInvocationHandler<T>	Provides an InvocationHandler for creating dynamic proxy instances of bean interfaces.
BeanRegistryLookup	Bean-modeling SPI seam that exposes the dictionary-lookup surface the bean-runtime types need without coupling the bean-modeling layer to the marshalling-side BeanRegistry.
BeanSession	Minimum runtime surface that the bean-modeling layer needs from a marshalling session.
BeanType	Annotation that can be applied to classes to control bean introspection and modeling.
BeanTypeAnnotation	Utility classes and methods for the @BeanType annotation.
BeanTypeAnnotation.Builder	Builder class.
BeanTypeResolver	Bean-modeling SPI seam that exposes the type-resolution operations the bean-property validation pass needs from the marshalling layer.
Delegate<T>	An object that represents another object, often wrapping that object.
Name	Specifies the parameter name for bean property mapping.
PropertyNamer	Defines an API for converting conventional bean property names to some other form.
PropertyNamer.Void	Represents a non-existent class.
PropertyNamerDLC	Converts property names to dashed-lower-case format.
PropertyNamerDUCS	Converts property names to dashed-upper-case-start format.
PropertyNamerULC	Converts property names to underscore-lower-case format.
PropertyValidator	Validates a bean-property value against a schema.
PropertyValidatorFactory	Builds PropertyValidator instances from a JSON-Schema-shaped map of constraints.
PropertyValidators	Discovery helper for PropertyValidatorFactory via ServiceLoader.