ObjectProvider


1   // Copyright 2004, 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.hivemind.service;
16  
17  import org.apache.hivemind.Location;
18  import org.apache.hivemind.internal.Module;
19  
20  /**
21   * A service which can provide an object value for the <code>indirect</code>
22   * translator.
23   *
24   * @author Howard Lewis Ship
25   */
26  public interface ObjectProvider
27  {
28      /**
29       * Invoked by the translator to provide the value.
30       * @param contributingModule the module which contributed to the locator
31       * @param propertyType the expected type of property
32       * @param locator a string that should be meaningful to this provider. It is the suffix of
33       * the original input value provided to the translator, after the selector prefix
34       * (used to choose a provider) was stripped.
35       * @param location the location of the input value (from which the locator was extracted). Used
36       * for error reporting, or to set the location of created objects.
37       */
38      public Object   provideObject(
39          Module contributingModule,
40          Class   propertyType,
41          String   locator,
42          Location location);
43  }
44
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags