net.leadware.persistence.tools.api.exceptions.JPersistenceToolsException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jpersistence-tools-api Show documentation
Module de spécification du Framework jpersistence-tools
The newest version!
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 net.leadware.persistence.tools.api.exceptions;


/**
 * Classe de Base des exception du Framework 
 * @author Jean-Jacques ETUNE NGI (Leadware Enterprise Architect)
 * @since 31 janv. 2018 - 14:23:08
 */
public class JPersistenceToolsException extends RuntimeException {
	
	/**
	 * Message d'erreur par defaut
	 */
	public static String DEFAULT_MESSAGE = "JPersistenceToolsException.messasge";

	/**
	 * Liste des parametres du message
	 */
	protected String[] parameters = null;
	
	/**
	 * ID Genere par Eclipse
	 */
	private static final long serialVersionUID = 1L;
	
	
	/**
	 * Constructeur par defaut
	 */
	public JPersistenceToolsException() {
		
		// Appel du Constructeur de RuntimeException
		super(DEFAULT_MESSAGE);
	}
	
	/**
	 * Constructeur avec Message
	 * @param message	Message a afficher
	 */
	public JPersistenceToolsException(String message){
		
		// Appel du constructeur de RuntimeException
		super(message);
	}
	
	/**
	 * Constructeur avec initialisation des parametres
	 * @param message	Message de l'exception
	 * @param parameters Liste des parametres du message
	 */
	public JPersistenceToolsException(String message, String[] parameters) {
		
		// Initialisation Parente
		super(message);
		
		// Parametres
		this.parameters = parameters;
	}
	
	/**
	 * Constructeur avec Message et de la cause
	 * @param message	Message a afficher
	 * @param cause	Cause de l'exception
	 */
	public JPersistenceToolsException(String message, Throwable cause) {
		
		// Appel du constructeur de Runtime
		super(message, cause);
	}

	/**
	 * Constructeur avec initialisation des parametres
	 * @param message	Message de l'exception
	 * @param parameters Liste des parametres du message
	 * @param cause	Cause de l'exception
	 */
	public JPersistenceToolsException(String message, String[] parameters, Throwable cause) {
		
		// Initialisation Parente
		this(message, cause);
		
		// Parametres
		this.parameters = parameters;
	}
	
	/**
	 * Constructeur avec de la cause
	 * @param cause	Exception cause
	 */
	public JPersistenceToolsException(Throwable cause) {
		
		// Appel du constructeur de Runtime
		super(DEFAULT_MESSAGE, cause);
	}

	/**
	 * Methode permettant d'obtenir la valeur du champ "parameters"
	 * @return valeur du champ "parameters"
	 */
	public String[] getParameters() {
	
		// On retourne le champ "parameters"
		return parameters;
	}

	/**
	 * Methode permettant de modifier la valeur du champ "parameters"
	 * @param parameters Nouvelle valeur du champ "parameters"
	 */
	public void setParameters(String[] parameters) {
	
		// Initialisation du champ "this.parameters"
		this.parameters = parameters;
	}
}