1 /*
2 * Copyright (C) 2015 Christian Schulte <cs@schulte.it>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * o Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * o Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
15 * distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
19 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $JOMC: ServiceFactory.java 5101 2016-04-04 18:52:11Z schulte $
29 *
30 */
31 package org.jomc.modlet;
32
33 /**
34 * {@code Service} factory interface.
35 *
36 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
37 * @version $JOMC: ServiceFactory.java 5101 2016-04-04 18:52:11Z schulte $
38 * @see ModelContext#createServiceObjects(java.lang.String, java.lang.String, java.lang.Class)
39 * @since 1.9
40 */
41 public interface ServiceFactory
42 {
43
44 /**
45 * Gets the ordinal number of the factory.
46 *
47 * @return The ordinal number of the factory.
48 */
49 int getOrdinal();
50
51 /**
52 * Creates a new service object.
53 *
54 * @param context The context to create a new service object with.
55 * @param service The service to create a new object of.
56 * @param type The class of the type of the service object.
57 * @param <T> The type of the service object.
58 *
59 * @return An new service object for {@code service} or {@code null}, if the factory is not responsible for creating
60 * service objects of {@code type}.
61 *
62 * @throws NullPointerException if {@code context}, {@code service} or {@code type} is {@code null}.
63 * @throws ModelException if creating the service object fails.
64 */
65 <T> T createServiceObject( ModelContext context, Service service, Class<T> type )
66 throws NullPointerException, ModelException;
67
68 }