info.magnolia.jcr.node2bean.impl

Class CollectionPropertyHidingTransformer

java.lang.Object

info.magnolia.jcr.node2bean.impl.Node2BeanTransformerImpl

info.magnolia.jcr.node2bean.impl.CollectionPropertyHidingTransformer

All Implemented Interfaces:

Node2BeanTransformer

Direct Known Subclasses:

CompositeFilterTransformer, VoterSetTransformer

public class CollectionPropertyHidingTransformer
extends Node2BeanTransformerImpl

A transformer which "hides" a collection node. Extend or pass the type and node name in the constructor.

Constructor Summary

Constructors

Constructor and Description
CollectionPropertyHidingTransformer(Class<?> beanClass, String collectionName)

Method Summary

Modifier and Type	Method and Description
boolean	canHandleValue(TypeMapping typeMapping, TransformationState state, PropertyTypeDescriptor descriptor, Map.Entry<String,Object> value) Returns whether this transformer can consume the given value and assign it to the currently-processed bean.
TypeDescriptor	getPropertyType()
protected TypeDescriptor	onResolveType(TypeMapping typeMapping, TransformationState state, TypeDescriptor resolvedType, ComponentProvider componentProvider) Called once the type should have been resolved.
void	setProperty(TypeMapping mapping, TransformationState state, PropertyTypeDescriptor descriptor, Map<String,Object> values) Set this property on that bean.
boolean	supportsValueClaims() Returns whether this transformer handles value claims, helping Node2BeanProcessor to report unknown bean properties.

Methods inherited from class info.magnolia.jcr.node2bean.impl.Node2BeanTransformerImpl

convertPropertyValue, createCollectionFromMap, getChildren, getProperties, initBean, isBeanEnabled, newBeanInstance, newState, resolveType

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionPropertyHidingTransformer

public CollectionPropertyHidingTransformer(Class<?> beanClass,
                                           String collectionName)

Parameters:

beanClass - class which collection will be hidden

collectionName - name of collection to hide

Method Detail

onResolveType

protected TypeDescriptor onResolveType(TypeMapping typeMapping,
                                       TransformationState state,
                                       TypeDescriptor resolvedType,
                                       ComponentProvider componentProvider)

Description copied from class: Node2BeanTransformerImpl

Called once the type should have been resolved. The resolvedType might be null if no type has been resolved. Every subclass should override this method.

Overrides:

onResolveType in class Node2BeanTransformerImpl

setProperty

public void setProperty(TypeMapping mapping,
                        TransformationState state,
                        PropertyTypeDescriptor descriptor,
                        Map<String,Object> values)
                 throws javax.jcr.RepositoryException

Description copied from interface: Node2BeanTransformer

Set this property on that bean. Allows excluding of properties.

Specified by:

setProperty in interface Node2BeanTransformer

Overrides:

setProperty in class Node2BeanTransformerImpl

Throws:

javax.jcr.RepositoryException

canHandleValue

public boolean canHandleValue(TypeMapping typeMapping,
                              TransformationState state,
                              PropertyTypeDescriptor descriptor,
                              Map.Entry<String,Object> value)

Description copied from interface: Node2BeanTransformer

Returns whether this transformer can consume the given value and assign it to the currently-processed bean.

This is used in conjunction with Node2BeanProcessor to help it report unknown properties (aka TransformationProblems).

Specified by:

canHandleValue in interface Node2BeanTransformer

Overrides:

canHandleValue in class Node2BeanTransformerImpl

Returns:

false by default, i.e. no reporting of unknown property problems.

supportsValueClaims

public boolean supportsValueClaims()

Description copied from interface: Node2BeanTransformer

Returns whether this transformer handles value claims, helping Node2BeanProcessor to report unknown bean properties.

Specified by:

supportsValueClaims in interface Node2BeanTransformer

Overrides:

supportsValueClaims in class Node2BeanTransformerImpl

Returns:

false by default; implementations must opt-in explicitly to use this feature, and implement #canHandleValue(TypeMapping, TransformationState, PropertyTypeDescriptor, Entry) accordingly.

getPropertyType

public TypeDescriptor getPropertyType()