Package edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.impl

Class PropertyBasedObjectIdGenerator

java.lang.Object

edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.annotation.ObjectIdGenerator<T>

edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.annotation.ObjectIdGenerators.PropertyGenerator

edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.impl.PropertyBasedObjectIdGenerator

All Implemented Interfaces:

Serializable

public class PropertyBasedObjectIdGenerator
extends ObjectIdGenerators.PropertyGenerator

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.annotation.ObjectIdGenerator

ObjectIdGenerator.IdKey

Field Summary

Fields

Modifier and Type	Field	Description
protected final BeanPropertyWriter	_property
protected final Class<?>	_scope

Constructor Summary

Constructors

Modifier	Constructor	Description
	PropertyBasedObjectIdGenerator(ObjectIdInfo oid, BeanPropertyWriter prop)
protected	PropertyBasedObjectIdGenerator(Class<?> scope, BeanPropertyWriter prop)

Method Summary

Modifier and Type	Method	Description
boolean	canUseFor(ObjectIdGenerator<?> gen)	We must override this method, to prevent errors when scopes are the same, but underlying class (on which to access property) is different.
ObjectIdGenerator<Object>	forScope(Class<?> scope)	Factory method to create a blueprint instance for specified scope.
Object	generateId(Object forPojo)	Method used for generating a new Object Identifier to serialize for given POJO.
final Class<?>	getScope()
ObjectIdGenerator.IdKey	key(Object key)	Method for constructing key to use for ObjectId-to-POJO maps.
ObjectIdGenerator<Object>	newForSerialization(Object context)	Factory method called to create a new instance to use for serialization: needed since generators may have state (next id to produce).

Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.annotation.ObjectIdGenerator

isValidReferencePropertyName, maySerializeAsObject

Methods inherited from class java.lang.Object

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

Field Details

_property

protected final BeanPropertyWriter _property

_scope

protected final Class<?> _scope

Constructor Details

PropertyBasedObjectIdGenerator

public PropertyBasedObjectIdGenerator(ObjectIdInfo oid,
 BeanPropertyWriter prop)

PropertyBasedObjectIdGenerator

protected PropertyBasedObjectIdGenerator(Class<?> scope,
 BeanPropertyWriter prop)

Method Details

canUseFor

public boolean canUseFor(ObjectIdGenerator<?> gen)

We must override this method, to prevent errors when scopes are the same, but underlying class (on which to access property) is different.

Returns:

True if this instance can be used as-is; false if not

generateId

public Object generateId(Object forPojo)

Description copied from class: ObjectIdGenerator

Method used for generating a new Object Identifier to serialize for given POJO.

Parameters:

forPojo - POJO for which identifier is needed

Returns:

Object Identifier to use.

forScope

public ObjectIdGenerator<Object> forScope(Class<?> scope)

Description copied from class: ObjectIdGenerator

Factory method to create a blueprint instance for specified scope. Generators that do not use scope may return 'this'.

Specified by:

forScope in class ObjectIdGenerator<Object>

newForSerialization

public ObjectIdGenerator<Object> newForSerialization(Object context)

Description copied from class: ObjectIdGenerator

Factory method called to create a new instance to use for serialization: needed since generators may have state (next id to produce).

Note that actual type of 'context' is edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.SerializerProvider, but can not be declared here as type itself (as well as call to this object) comes from databind package.

Specified by:

newForSerialization in class ObjectIdGenerator<Object>

Parameters:

context - Serialization context object used (of type edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.SerializerProvider); may be needed by more complex generators to access contextual information such as configuration.

key

public ObjectIdGenerator.IdKey key(Object key)

Description copied from class: ObjectIdGenerator

Method for constructing key to use for ObjectId-to-POJO maps.

Specified by:

key in class ObjectIdGenerator<Object>

getScope

public final Class<?> getScope()

Specified by:

getScope in class ObjectIdGenerator<T>