View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software 
12   * distributed under the License is distributed on an "AS IS" BASIS, 
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
14   * See the License for the specific language governing permissions and 
15   * limitations under the License.
16   */
17  
18  /*
19   * AttachLifecycleListener.java
20   *
21   */
22   
23  package javax.jdo.listener;
24  
25  /**
26   * This interface is implemented by listeners to be notified of
27   * attach events.
28   * @version 2.0
29   * @since 2.0
30   */
31  public interface AttachLifecycleListener
32      extends InstanceLifecycleListener {
33      
34      /**
35       * This method is called before a detached instance is attached, via the
36       * {@link javax.jdo.PersistenceManager#makePersistent} method. The source 
37       * instance is the detached instance. This method is called before the
38       * corresponding {@link AttachCallback#jdoPreAttach} on the detached
39       * instance.
40       * @param event the attach event.
41       * @since 2.0
42       */
43      void preAttach (InstanceLifecycleEvent event);
44      
45      /**
46       * This method is called after a detached instance is attached, via the
47       * {@link javax.jdo.PersistenceManager#makePersistent} method. The source
48       * instance is the corresponding persistent instance in the cache; the
49       * target instance is the detached instance. This method is called after
50       * the corresponding {@link AttachCallback#jdoPostAttach} on the
51       * persistent instance.
52       * @param event the attach event.
53       * @since 2.0
54       */
55      void postAttach (InstanceLifecycleEvent event);
56  }