com.feilong.lib.xstream.io.HierarchicalStreamDriver Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
/*
* Copyright (C) 2004, 2005 Joe Walnes.
* Copyright (C) 2006, 2007, 2011 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
* style license a copy of which has been included with this distribution in
* the LICENSE.txt file.
*
* Created on 07. March 2004 by Joe Walnes
*/
package com.feilong.lib.xstream.io;
import java.io.File;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.io.Writer;
import java.net.URL;
/**
* Provides implementation of stream parsers and writers to XStream.
*
* @author Joe Walnes
* @author James Strachan
*/
public interface HierarchicalStreamDriver{
/**
* Create the HierarchicalStreamReader with the stream parser reading from the IO reader.
*
* @param in
* the {@link Reader} with the data to parse
* @return the HierarchicalStreamReader
*/
HierarchicalStreamReader createReader(Reader in);
/**
* Create the HierarchicalStreamReader with the stream parser reading from the input stream.
*
* @param in
* the {@link InputStream} with the data to parse
* @since 1.1.3
*/
HierarchicalStreamReader createReader(InputStream in);
/**
* Create the HierarchicalStreamReader with the stream parser reading from a URL.
*
* Depending on the parser implementation, some might take the URL as SystemId to resolve
* additional references.
*
* @param in
* the {@link URL} defining the location with the data to parse
* @return the HierarchicalStreamReader
* @since 1.4
*/
HierarchicalStreamReader createReader(URL in);
/**
* Create the HierarchicalStreamReader with the stream parser reading from a File.
*
* Depending on the parser implementation, some might take the file path as SystemId to
* resolve additional references.
*
* @param in
* the {@link URL} defining the location with the data to parse
* @return the HierarchicalStreamReader
* @since 1.4
*/
HierarchicalStreamReader createReader(File in);
/**
* Create the HierarchicalStreamWriter with the formatted writer.
*
* @param out
* the {@link Writer} to receive the formatted data
* @return the HierarchicalStreamWriter
*/
HierarchicalStreamWriter createWriter(Writer out);
/**
* Create the HierarchicalStreamWriter with the formatted writer.
*
* @param out
* the {@link OutputStream} to receive the formatted data
* @return the HierarchicalStreamWriter
* @since 1.1.3
*/
HierarchicalStreamWriter createWriter(OutputStream out);
}