org.codehaus.stax2.io.Stax2FileSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stax2-api Show documentation

Stax2 API is an extension to basic Stax 1.0 API that adds significant new functionality, such as full-featured bi-direction validation interface and high-performance Typed Access API.

There is a newer version: 4.2.2

Show newest version

package org.codehaus.stax2.io;

import java.io.*;
import java.net.URL;

/**
 * Simple implementation of {@link Stax2ReferentialSource}, which refers
 * to the specific file.
 */
public class Stax2FileSource
    extends Stax2ReferentialSource
{
    final File _file;

    public Stax2FileSource(File f) {
        _file = f;
    }

    /*
    /**********************************************************************
    /* Implementation of the Public API
    /**********************************************************************
     */

    /**
     * @return URL that refers to the reference resource, for the purposes
     *   of resolving a relative reference from content read from the
     *   resource.
     */
    public URL getReference()
    {
        /* !!! 13-May-2006, TSa: For Woodstox 4.0, consider converting
         *   first to URI, then to URL, to ensure that characters in the
         *   filename are properly quoted
         */
        try {
            return _file.toURL();
        } catch (java.net.MalformedURLException e) {
            /* Hmmh. Signature doesn't allow IOException to be thrown. So,
             * let's use something close enough; this should not occur
             * often in practice.
             */
            throw new IllegalArgumentException("(was "+e.getClass()+") Could not convert File '"+_file.getPath()+"' to URL: "+e);
        }
    }

    public Reader constructReader()
        throws IOException
    {
        String enc = getEncoding();
        if (enc != null && enc.length() > 0) {
            return new InputStreamReader(constructInputStream(), enc);
        }
        // Sub-optimal; really shouldn't use the platform default encoding
        return new FileReader(_file);
    }

    public InputStream constructInputStream()
        throws IOException
    {
        return new FileInputStream(_file);
    }

    /*
    /**********************************************************************
    /* Additional API for this source
    /**********************************************************************
     */

    public File getFile() {
        return _file;
    }
}