ListenerMap


1   // Copyright 2005 The Apache Software Foundation
2   //
3   // Licensed under the Apache License, Version 2.0 (the "License");
4   // you may not use this file except in compliance with the License.
5   // You may obtain a copy of the License at
6   //
7   //     http://www.apache.org/licenses/LICENSE-2.0
8   //
9   // Unless required by applicable law or agreed to in writing, software
10  // distributed under the License is distributed on an "AS IS" BASIS,
11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  // See the License for the specific language governing permissions and
13  // limitations under the License.
14  
15  package org.apache.tapestry.listener;
16  
17  import java.util.Collection  ;
18  
19  import org.apache.tapestry.IActionListener;
20  
21  /**
22   * @author Howard M. Lewis Ship
23   */
24  public interface ListenerMap
25  {
26      /**
27       * Gets a listener for the given name (which is both a property name and a method name). The
28       * listener is created as needed, but is also cached for later use. The returned object
29       * implements the {@link org.apache.tapestry.IActionListener}.
30       * 
31       * @param name
32       *            the name of the method to invoke (the most appropriate method will be selected if
33       *            there are multiple overloadings of the same method name)
34       * @returns an object implementing {@link IActionListener}.
35       * @throws ApplicationRuntimeException
36       *             if the listener can not be created.
37       */
38      public IActionListener getListener(String   name);
39  
40      /**
41       * Returns an unmodifiable collection of the names of the listeners implemented by the target
42       * class.
43       * 
44       * @since 1.0.6
45       */
46      public Collection   getListenerNames();
47  
48      /**
49       * Returns true if this ListenerMapImpl can provide a listener with the given name.
50       * 
51       * @since 2.2
52       */
53      public boolean canProvideListener(String   name);
54  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags