View Javadoc
1   /*
2    *   Copyright (C) 2005 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: ModletProvider.java 5101 2016-04-04 18:52:11Z schulte $
29   *
30   */
31  package org.jomc.modlet;
32  
33  /**
34   * {@code Modlet} provider interface.
35   *
36   * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
37   * @version $JOMC: ModletProvider.java 5101 2016-04-04 18:52:11Z schulte $
38   * @see ModelContext#findModlets(org.jomc.modlet.Modlets)
39   */
40  public interface ModletProvider
41  {
42  
43      /**
44       * Gets the ordinal number of the provider.
45       *
46       * @return The ordinal number of the provider.
47       *
48       * @since 1.6
49       */
50      int getOrdinal();
51  
52      /**
53       * Searches a given context for {@code Modlets}.
54       *
55       * @param context The context to search for {@code Modlets}.
56       *
57       * @return The {@code Modlets} found in the context or {@code null}, if no {@code Modlets} are found.
58       *
59       * @throws NullPointerException if {@code context} is {@code null}.
60       * @throws ModelException if searching the context fails.
61       * @deprecated As of JOMC 1.6, replaced by {@link #findModlets(org.jomc.modlet.ModelContext, org.jomc.modlet.Modlets)}.
62       * This method will be removed in JOMC 2.0.
63       */
64      @Deprecated
65      Modlets findModlets( ModelContext context ) throws NullPointerException, ModelException;
66  
67      /**
68       * Searches a given context for {@code Modlets}.
69       *
70       * @param context The context to search for {@code Modlets}.
71       * @param modlets The {@code Modlets} currently being searched.
72       *
73       * @return The {@code Modlets} found in the context or {@code null}, if no {@code Modlets} are found.
74       *
75       * @throws NullPointerException if {@code context} or {@code modlets} is {@code null}.
76       * @throws ModelException if searching the context fails.
77       * @since 1.6
78       */
79      Modlets findModlets( ModelContext context, Modlets modlets ) throws NullPointerException, ModelException;
80  
81  }