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   *  RegisterClassListener.java
20   *
21   */
22  
23  package javax.jdo.spi;
24  
25  import java.util.EventListener;
26  
27  /**
28   * A "RegisterClassEvent" event gets fired whenever a persistence-capable class 
29   * is loaded and gets registered with the <code>JDOImplHelper</code>. You can register a 
30   * <code>RegisterClassListener</code> so as to be notified of any registration of a 
31   * persistence-capable class.
32   *
33   * @version 1.0
34   */
35  public interface RegisterClassListener 
36      extends EventListener
37  {
38      /**
39       * This method gets called when a persistence-capable class is registered.
40       * @param event a <code>RegisterClassEvent</code> instance describing the registered 
41       * class plus metadata.
42       */
43      public void registerClass(RegisterClassEvent event);
44  }