/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2008 - 2009, Geomatys
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 2.1 of the License, or (at your option) any later version.
 *
 *    This library 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.
 */
package org.geotoolkit.ows.xml.v100;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.CollapsedStringAdapter;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.geotoolkit.ows.xml.ExceptionResponse;


/**
 * <p>Java class for anonymous complex type.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.
 * 
 * <pre>
 * <complexType>
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <sequence>
 *         <element ref="{http://www.opengis.net/ows}Exception" maxOccurs="unbounded"/>
 *       </sequence>
 *       <attribute name="version" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
 *       <attribute name="language" type="{http://www.w3.org/2001/XMLSchema}language" />
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * </pre>
 * 
 * 
 * @module
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
    "exception"
})
@XmlRootElement(name = "ExceptionReport")
public class ExceptionReport implements ExceptionResponse {

    @XmlElement(name = "Exception", required = true)
    private List<ExceptionType> exception;
    @XmlAttribute(required = true)
    private String version;
    @XmlAttribute
    @XmlJavaTypeAdapter(CollapsedStringAdapter.class)
    @XmlSchemaType(name = "language")
    private String language;

    /**
     * Empty constructor used by JAXB.
     */
    ExceptionReport() {}
    
    /**
     * Build a new full exception with the specified text, code and locator.
     * 
     * @param exceptionText 
     * @param exceptionCode
     */
    public ExceptionReport(final String exceptionText, final String exceptionCode, final String locator, final String version) {
        exception = new ArrayList<ExceptionType>();
        this.exception.add(new ExceptionType(exceptionText, exceptionCode, locator));
        if (version != null)
            this.version = version.toString();
    }
    
    /**
     * Unordered list of one or more Exception elements that each describes an error. 
     * These Exception elements shall be interpreted by clients as being independent of one another (not hierarchical). 
     * Gets the value of the exception property.
     * (unmodifiable)
     */
    public List<ExceptionType> getException() {
        if (exception == null) {
            exception = new ArrayList<ExceptionType>();
        }
        return Collections.unmodifiableList(exception);
    }

    /**
     * Gets the value of the version property.
     */
    public String getVersion() {
        return version;
    }

    /**
     * Gets the value of the language property.
     */
    public String getLanguage() {
        return language;
    }

    /**
     * Verify that this entry is identical to the specified object.
     */
    @Override
    public boolean equals(final Object object) {
        if (object == this) {
            return true;
        }
        if (object instanceof ExceptionReport) {
            final ExceptionReport that = (ExceptionReport) object;
            return Objects.equals(this.exception, that.exception) &&
                   Objects.equals(this.language,  that.language)   &&
                   Objects.equals(this.version,   that.version);
        }
        return false;
    }

    @Override
    public int hashCode() {
        int hash = 5;
        hash = 41 * hash + (this.exception != null ? this.exception.hashCode() : 0);
        hash = 41 * hash + (this.version != null ? this.version.hashCode() : 0);
        hash = 41 * hash + (this.language != null ? this.language.hashCode() : 0);
        return hash;
    }

    /**
     * Return a String representation of the exception report.
     * 
     * @return A String representation of the exception report.
     */
    @Override
    public String toString() {
        StringBuilder s = new StringBuilder("[ExceptionReport]");
        if (language != null)
            s.append('[').append(language).append(']');
        if (version != null)
            s.append('[').append(version).append(']');
        s.append('\n');
        if (exception != null) {
            int i = 0;
            for (ExceptionType ex: exception) {
                s.append("exception ").append(i).append(':').append(ex.toString()).append('\n');
                i++;
            }
        }
        return s.toString();
    }
}