View Javadoc

1   // SECTION-START[License Header]
2   // <editor-fold defaultstate="collapsed" desc=" Generated License ">
3   /*
4    *   Java Object Management and Configuration
5    *   Copyright (C) Christian Schulte, 2005-206
6    *   All rights reserved.
7    *
8    *   Redistribution and use in source and binary forms, with or without
9    *   modification, are permitted provided that the following conditions
10   *   are met:
11   *
12   *     o Redistributions of source code must retain the above copyright
13   *       notice, this list of conditions and the following disclaimer.
14   *
15   *     o Redistributions in binary form must reproduce the above copyright
16   *       notice, this list of conditions and the following disclaimer in
17   *       the documentation and/or other materials provided with the
18   *       distribution.
19   *
20   *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
21   *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
22   *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
23   *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
24   *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25   *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26   *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27   *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28   *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29   *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30   *
31   *   $JOMC: Locator.java 4795 2013-04-21 09:09:02Z schulte $
32   *
33   */
34  // </editor-fold>
35  // SECTION-END
36  package org.jomc.spi;
37  
38  import java.io.IOException;
39  import java.net.URI;
40  
41  // SECTION-START[Documentation]
42  // <editor-fold defaultstate="collapsed" desc=" Generated Documentation ">
43  /**
44   * Locates objects.
45   *
46   * <dl>
47   *   <dt><b>Identifier:</b></dt><dd>org.jomc.spi.Locator</dd>
48   *   <dt><b>Multiplicity:</b></dt><dd>Many</dd>
49   *   <dt><b>Scope:</b></dt><dd>None</dd>
50   * </dl>
51   *
52   * @author <a href="mailto:cs@schulte.it">Christian Schulte</a> 1.0
53   * @version 1.0
54   * @see org.jomc.ObjectManager#getObject(java.lang.Class) getObject(Locator[].class)
55   * @see org.jomc.ObjectManager#getObject(java.lang.Class,java.lang.String) getObject(Locator.class, "<i>implementation name</i>")
56   * @see org.jomc.ObjectManagerFactory
57   */
58  // </editor-fold>
59  // SECTION-END
60  // SECTION-START[Annotations]
61  // <editor-fold defaultstate="collapsed" desc=" Generated Annotations ">
62  @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.5", comments = "See http://www.jomc.org/jomc/1.5/jomc-tools-1.5" )
63  // </editor-fold>
64  // SECTION-END
65  public interface Locator
66  {
67      // SECTION-START[Locator]
68  
69      /**
70       * Gets an object for a given location URI.
71       *
72       * @param specification The specification class of the object to locate.
73       * @param location The location URI of the object to locate.
74       * @param <T> The type of the object.
75       *
76       * @return The object located at {@code location} or {@code null}, if no object is found at {@code location}.
77       *
78       * @throws NullPointerException if {@code specification} or {@code location} is {@code null}.
79       * @throws IOException if locating the object fails.
80       */
81      <T> T getObject( Class<T> specification, URI location ) throws NullPointerException, IOException;
82  
83      // SECTION-END
84  }