org.tweetyproject.commons.TweetyConfiguration Maven / Gradle / Ivy

Go to download
/*
 *  This file is part of "TweetyProject", a collection of Java libraries for
 *  logical aspects of artificial intelligence and knowledge representation.
 *
 *  TweetyProject is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License version 3 as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program. If not, see .
 *
 *  Copyright 2016 The TweetyProject Team 
 */
package org.tweetyproject.commons;

/**
 * This interface contains some configuration options for
 * Tweety.
 * 
 * @author Matthias Thimm
 */
public interface TweetyConfiguration {
	
	//TODO: Add more configuration options:
	//- Set default reasoners globally
	//- Set precision globally
	//- commons.BeliefSet: toggle EQUALS_USES_SIGNATURE
	//- logics.fol.syntax.FolSignature: toggle whether EqualityPredicate and InequalityPredicate are included in all signatures
	//- Improve/use logging levels

	/**
	 * The possible log levels.
	 * 
	 * @author Matthias Thimm
	 */
	public enum LogLevel{
		/** 
		 * TRACE
		 */
	    TRACE (5, "trace"),
	    /** 
	     * DEBUG
	     */
	    DEBUG (4, "debug"),
	    /** 
	     * INFO
	     */
	    INFO (3, "info"),
	    /** 
	     * WARN
	     */
	    WARN (2, "warn"),
	    /** 
	     * ERROR
	     */
	    ERROR (1, "error"),
	    /** 
	     * FATAL
	     */
	    FATAL (0, "fatal");
	    
	    /** The log level as integer */
	    private final int levelAsInt;  
	    /** The log level as string */
	    private final String levelAsString;
	    
	    /** Creates a new LogLevel */
	    LogLevel(int levelAsInt, String levelAsString) {
	    	/** levelAsInt */
	        this.levelAsInt = levelAsInt;
	        /** levelAsString */
	        this.levelAsString = levelAsString;
	    }
	    
/**
 * Returns the log level as integer 
 * @return levelAsInt
 */
	   
	    public int levelAsInt(){ return this.levelAsInt; }
	    
	    /** 
	     * Returns the log level as string
	     * @return log level as string
	     */
	    public String levelAsString(){ return this.levelAsString; }
	    
	    /**
	     * Returns the log level described by the given string
	     * @param s string describing log level
	     * @return the log level described by the given string
	     */
	    public static LogLevel getLogLevel(String s){
	    	for(LogLevel l: LogLevel.values()){
	    		if(l.levelAsString.equals(s.toLowerCase()))
	    			return l;
	    		try{
	    			if(l.levelAsInt == Integer.parseInt(s))
	    				return l;
	    		}catch(Exception e){}
	    	}
	    	throw new IllegalArgumentException("The given string does not represent a log level.");	
	    }
	}
}