1 /*
2 * Copyright (C) Christian Schulte <cs@schulte.it>, 2014-005
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: ModletProcessor.java 5043 2015-05-27 07:03:39Z schulte $
29 *
30 */
31 package org.jomc.modlet;
32
33 /**
34 * {@code Modlet} processor interface.
35 *
36 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
37 * @version $JOMC: ModletProcessor.java 5043 2015-05-27 07:03:39Z schulte $
38 * @see ModelContext#processModlets(org.jomc.modlet.Modlets)
39 * @since 1.6
40 */
41 public interface ModletProcessor
42 {
43
44 /**
45 * Gets the ordinal number of the processor.
46 *
47 * @return The ordinal number of the processor.
48 */
49 int getOrdinal();
50
51 /**
52 * Processes a given list of {@code Modlet}s with a context.
53 *
54 * @param context The context to process {@code Modlets} with.
55 * @param modlets The {@code Modlets} currently being processed.
56 *
57 * @return The processed {@code Modlets} or {@code null}.
58 *
59 * @throws NullPointerException if {@code context} or {@code modlets} is {@code null}.
60 * @throws ModelException if processing {@code Modlets} fails.
61 */
62 Modlets processModlets( ModelContext context, Modlets modlets ) throws NullPointerException, ModelException;
63
64 }