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 /**
29 * This class defines a Prolog operator. Prolog operators are composed by a
30 * string operator name, string operator specifier or type and a operator
31 * priority. Extends from {@link Comparable} to compare with others operators
32 * instance over priority property.
33 *
34 * @author Jose Zalacain
35 * @since 1.0
36 */
37 public interface PrologOperator extends Comparable<PrologOperator> {
38
39 /**
40 * String symbol that represent the Prolog operator.
41 *
42 * @return the Prolog operator symbol.
43 * @since 1.0
44 */
45 public String getOperator();
46
47 /**
48 * String symbol that specify the associativity and position of the Prolog
49 * operator.
50 *
51 * @return symbol that specify associativity and position of the Prolog
52 * operator.
53 * @since 1.0
54 */
55 public String getSpecifier();
56
57 /**
58 * Integer number between 0 and 1200 that represent the operator priority.
59 *
60 * @return the operator priority.
61 * @since 1.0
62 */
63 public int getPriority();
64
65 }