org.apache.xerces.impl.io.MalformedByteSequenceException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xercesImpl Show documentation

Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family. This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is the reference implementation of XNI but other parser components, configurations, and parsers can be written using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual. Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema 1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that it does not yet provide an option to enable normalization checking as described in section 2.13 of this specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.

There is a newer version: 2.12.2

Show 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 org.apache.xerces.impl.io;

import java.io.CharConversionException;
import java.util.Locale;

import org.apache.xerces.util.MessageFormatter;

/**
 * Signals that a malformed byte sequence was detected
 * by a java.io.Reader that decodes bytes 
 * of a given encoding into characters.
 * 
 * @xerces.internal
 *
 * @author Michael Glavassevich, IBM
 *
 * @version $Id: MalformedByteSequenceException.java 718095 2008-11-16 20:00:14Z mrglavas $
 */
public final class MalformedByteSequenceException extends CharConversionException {

    /** Serialization version. */
    static final long serialVersionUID = 8436382245048328739L;
    
    //
    // Data
    //
    
    /** message formatter **/
    private MessageFormatter fFormatter;
    
    /** locale for error message **/
    private Locale fLocale;
    
    /** error domain **/
    private String fDomain;
    
    /** key for the error message **/
    private String fKey;
    
    /** replacement arguements for the error message **/
    private Object[] fArguments;
    
    /** message text for this message, initially null **/
    private String fMessage;
    
    //
    // Constructors
    //

    /**
     * Constructs a MalformedByteSequenceException with the given
     * parameters which may be passed to an error reporter to 
     * generate a localized string for this exception.
     * 
     * @param formatter The MessageFormatter used for building the 
     *                  message text for this exception.
     * @param locale    The Locale for which messages are to be reported.
     * @param domain    The error domain.
     * @param key       The key of the error message.
     * @param arguments The replacement arguments for the error message,
     *                  if needed.
     */
    public MalformedByteSequenceException(MessageFormatter formatter,
        Locale locale, String domain, String key, Object[] arguments) {
        fFormatter = formatter;
        fLocale = locale;
        fDomain = domain;
        fKey = key;
        fArguments = arguments;
    } // (MessageFormatter, Locale, String, String, Object[])
    
    //
    // Public methods
    //
    
    /**
     * Returns the error domain of the error message.
     * 
     * @return the error domain
     */
    public String getDomain () {
    	return fDomain;
    } // getDomain
    
    /**
     * Returns the key of the error message.
     * 
     * @return the error key of the error message
     */
    public String getKey () {
    	return fKey;
    } // getKey()
    
    /**
     * Returns the replacement arguments for the error
     * message or null if none exist.
     * 
     * @return the replacement arguments for the error message
     * or null if none exist
     */
    public Object[] getArguments () {
    	return fArguments;
    } // getArguments();
    
    /**
     * Returns the localized message for this exception.
     * 
     * @return the localized message for this exception.
     */
    public synchronized String getMessage() {
        if (fMessage == null) {
            fMessage = fFormatter.formatMessage(fLocale, fKey, fArguments);
            // The references to the message formatter and locale
            // aren't needed anymore so null them.
            fFormatter = null;
            fLocale = null;
        }
        return fMessage;
     } // getMessage()
     
} // MalformedByteSequenceException