org.nakedobjects.runtime.persistence.adaptermanager.AdapterManager Maven / Gradle / Ivy
package org.nakedobjects.runtime.persistence.adaptermanager;
import org.nakedobjects.metamodel.adapter.NakedObject;
import org.nakedobjects.metamodel.adapter.ResolveState;
import org.nakedobjects.metamodel.adapter.oid.Oid;
import org.nakedobjects.metamodel.adapter.version.Version;
import org.nakedobjects.metamodel.commons.component.Injectable;
import org.nakedobjects.metamodel.spec.NakedObjectSpecification;
import org.nakedobjects.metamodel.spec.identifier.Identified;
/**
* Responsible for managing the {@link NakedObject adapter}s and {@link Oid identities} for each and every
* POJO that is being used by the framework.
*
*
* It provides a consistent set of adapters in memory, providing an {@link NakedObject adapter} for the POJOs
* that are in use ensuring that the same object is not loaded twice into memory.
*
*
* Each POJO is given an {@link NakedObject adapter} so that the framework can work with the POJOs even though
* it does not understand their types. Each POJO maps to an {@link NakedObject adapter} and these are reused.
*/
public interface AdapterManager extends AdapterManagerLookup, Injectable {
///////////////////////////////////////////////////////////
// lookup/creation
///////////////////////////////////////////////////////////
/**
* Either returns an existing adapter (as per {@link #getAdapterFor(Object)}), otherwise creates either a
* transient, standalone or aggregated {@link NakedObject adapter} for the supplied domain object,
* depending on its {@link NakedObjectSpecification} and the context arguments provided.
*
*
* If no adapter is found for the provided pojo, then the rules for creating the {@link NakedObject
* adapter} are as follows:
*
* - if the pojo's {@link NakedObjectSpecification specification} indicates that this is an immutable
* value, then a {@link ResolveState#STANDALONE} {@link NakedObject adapter} is created
*
- otherwise, if context ownerAdapter and identified arguments have both been
* provided and also either the {@link Identified} argument indicates that for this particular
* property/collection the object is aggregated or that the pojo's own
* {@link NakedObjectSpecification specification} indicates that the pojo is intrinsically aggregated,
* then an {@link NakedObject#isAggregated() aggregated} adapter is created. Note that the
* {@link ResolveState} of such {@link NakedObject's} is independent of its ownerAdapter, but it
* has the same {@link NakedObject#setOptimisticLock(Version) optimistic locking version}.
*
- otherwise, a {@link ResolveState#TRANSIENT} {@link NakedObject adapter} is created.
*
*
* @param pojo
* - pojo to adapt
* @param ownerAdapter
* - only used if aggregated
* @param identifier
* - only used if aggregated
*/
public NakedObject adapterFor(final Object pojo, final NakedObject ownerAdapter, Identified identified);
/**
* Either returns an existing adapter (as per {@link #getAdapterFor(Object)}), otherwise creates either a
* transient root or a standalone {@link NakedObject adapter} for the supplied domain object, depending on
* its {@link NakedObjectSpecification}.
*
*
* The rules for creating a {@link ResolveState#STANDALONE standalone} vs {@link ResolveState#TRANSIENT
* transient} root {@link NakedObject adapter} are as for
* {@link #adapterFor(Object, NakedObject, Identified)}.
*
*
* Historical notes: previously called createAdapterForTransient, though this name wasn't quite
* right.
*/
NakedObject adapterFor(Object pojo);
///////////////////////////////////////////////////////////
// removal
///////////////////////////////////////////////////////////
/**
* Removes the specified adapter from the identity maps.
*/
void removeAdapter(NakedObject adapter);
}
// Copyright (c) Naked Objects Group Ltd.