org.bml.util.errorconsumer.ParseError.java Source code

Introduction

Here is the source code for org.bml.util.errorconsumer.ParseError.java

Source

package org.bml.util.errorconsumer;

/*
 * #%L
 * org.bml
 * %%
 * Copyright (C) 2006 - 2014 Brian M. Lima
 * %%
 * This file is part of ORG.BML.
 * 
 *     ORG.BML is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 * 
 *     ORG.BML 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 ORG.BML.  If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

import java.util.HashMap;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Holder for data related to pixel parse errors.
 *
 * @author Brian M. Lima
 */
public class ParseError extends Throwable {

    /**
     * STD Logging
     */
    private static Log LOG = LogFactory.getLog(ParseError.class);
    /**
     * A String representation of the reporting class Name.
     */
    private String className = null;
    /**
     * A String representation of the request URI.
     */
    private String queryString = null;
    /**
     * A String description of the error encountered.
     */
    private String reason = null;

    /**
     * @param queryString A String representation of the request URI.
     * @param error A String description of the error encountered.
     */
    public ParseError(String className, String queryString, String error) {
        super(error);
        this.queryString = queryString;
        this.reason = error;
        this.className = className;
    }

    /**
     * A String representation of the request URI.
     *
     * @return the request
     */
    public String getQueryString() {
        return queryString;
    }

    /**
     * A String representation of the request URI.
     *
     * @param request the request to set
     */
    public void setQueryString(String request) {
        this.queryString = request;
    }

    /**
     * A String description of the error encountered.
     *
     * @return the error
     */
    public String getReason() {
        return reason;
    }

    /**
     * A String description of the reason for the error.
     *
     * @param reason the reason the error occurred
     */
    public void setReason(String reason) {
        this.reason = reason;
    }

    public Map<String, String> toParamMap() {
        Map<String, String> paramMap = new HashMap<String, String>();
        paramMap.put("class_name".intern(), this.getClassName());
        paramMap.put("uri".intern(), this.getQueryString());
        paramMap.put("reason".intern(), this.getReason());
        return paramMap;
    }

    /**
     * @return the className
     */
    public String getClassName() {
        return className;
    }

    /**
     * @param className the className to set
     */
    public void setClassName(String className) {
        this.className = className;
    }
}