1 /*
2 * #%L
3 * prolobjectlink-jpi
4 * %%
5 * Copyright (C) 2019 Prolobjectlink Project
6 * %%
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 * #L%
25 */
26 package io.github.prolobjectlink.prolog;
27
28 import java.util.List;
29
30 /**
31 * Clause family list that join all clauses with same functor/arity based
32 * indicator. Support all {@link List} operations to manage clauses in the
33 * family list.
34 *
35 * @author Jose Zalacain
36 * @since 1.0
37 */
38 public interface PrologClauses extends List<PrologClause> {
39
40 /**
41 * True if this clause family list is a dynamic, false in other case
42 *
43 * @deprecated Natives engine don't offer information about that.
44 * @return whether this clause family list is a dynamic
45 * @since 1.0
46 */
47 @Deprecated
48 public boolean isDynamic();
49
50 /**
51 * True if this clause family list is a multifile, false in other case
52 *
53 * @deprecated Natives engine don't offer information about that.
54 * @return whether this clause family list is a multifile
55 * @since 1.0
56 */
57 @Deprecated
58 public boolean isMultifile();
59
60 /**
61 * True if this clause family list is a discontiguos, false in other case
62 *
63 * @deprecated Natives engine don't offer information about that.
64 * @return whether this clause family list is a discontiguos.
65 * @since 1.0
66 */
67 @Deprecated
68 public boolean isDiscontiguous();
69
70 /**
71 * Clause family functor/arity based indicator. The clause family indicator is
72 * the same indicator for all clauses head in the clause family.
73 *
74 * @return functor/arity based indicator of the current clause family.
75 * @since 1.0
76 */
77 public String getIndicator();
78
79 }