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 * Indicator to denote the signature for Prolog Terms using a functor/arity 30 * format. More formally the indicator is formed by the concatenation of the 31 * term functor and term arity separated by slash. 32 * 33 * @author Jose Zalacain 34 * @since 1.0 35 */ 36 public interface PrologIndicator { 37 38 /** 39 * Indicator arity that is the argument number for compound terms. If the 40 * indicator is not associate to a compound term then the arity is zero. 41 * 42 * @return indicator arity. 43 * @since 1.0 44 */ 45 public int getArity(); 46 47 /** 48 * Indicator functor that is the name for compound terms. 49 * 50 * @return indicator functor for compound terms. 51 * @since 1.0 52 */ 53 public String getFunctor(); 54 55 /** 56 * Gets the term indicator represented by one string with the format 57 * functor/arity. More formally the indicator string is formed by the 58 * concatenation of {@link #getFunctor()} and {@link #getArity()} separated by 59 * slash. 60 * 61 * @return term indicator 62 * @since 1.0 63 */ 64 public String getIndicator(); 65 66 }