/*
* Copyright 2014 Igor Maznitsa (http://www.igormaznitsa.com).
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.igormaznitsa.prol.exceptions;
import com.igormaznitsa.prol.data.Term;
import com.igormaznitsa.prol.data.TermStruct;
/**
* The class describes the prolog type_error exception. There shall be a Type
* Error when the type of an argument or of one of its components is incorrect,
* but not a variable (which might be an instantiation_error).
*
* @author Igor Maznitsa (igor.maznitsa@igormaznitsa.com)
*/
public class ProlTypeErrorException extends ProlAbstractCatcheableException {
private static final long serialVersionUID = -3258214534404942716L;
/**
* The common shared constant between instances of the exception
*/
private static final Term TERM_ERROR = new Term("type_error");
/**
* The variable contains the valid type
*/
private final String validType;
/**
* A constructor
*
* @param validType the valid type
* @param culprit the culprit term
* @param cause the java throwable exception which is the cause for the error
*/
public ProlTypeErrorException(final String validType, final Term culprit, final Throwable cause) {
super(culprit, cause);
this.validType = validType;
}
/**
* A constructor
*
* @param validType the valid type
* @param message a text message describing the situation
* @param culprit the culprit term
* @param cause the java throwable exception which is the cause for the error
*/
public ProlTypeErrorException(final String validType, final String message, final Term culprit, final Throwable cause) {
super(message, culprit, cause);
this.validType = validType;
}
/**
* A constructor
*
* @param validType the valid type
* @param message a text message describing the situation
* @param culprit the culprit term
*/
public ProlTypeErrorException(final String validType, final String message, final Term culprit) {
super(message, culprit);
this.validType = validType;
}
/**
* A constructor
*
* @param validType the valid type
* @param culprit the culprit term
*/
public ProlTypeErrorException(final String validType, final Term culprit) {
super(culprit);
this.validType = validType;
}
/**
* Get the valid type
*
* @return the valid type as a String object
*/
public String getValidType() {
return validType;
}
@Override
public Term getFunctorForErrorStruct() {
return TERM_ERROR;
}
@Override
public TermStruct getAsStruct() {
final TermStruct result = new TermStruct(TERM_ERROR, new Term[]{validType == null ? UNDEFINED : new Term(validType), getCulprit() == null ? UNDEFINED : getCulprit()});
result.setCarriedObject(this);
return result;
}
}