From 40a9d99496e098562f090fb7ffce9e749011b131 Mon Sep 17 00:00:00 2001 From: Benjamin Culkin Date: Mon, 20 May 2024 17:58:16 -0400 Subject: Formatting pass --- .../net/wotonomy/foundation/xml/XMLDecoder.java | 61 ++++++++++------------ .../net/wotonomy/foundation/xml/XMLEncoder.java | 50 ++++++++---------- 2 files changed, 51 insertions(+), 60 deletions(-) (limited to 'projects/net.wotonomy.foundation/src/main/java/net/wotonomy/foundation/xml') diff --git a/projects/net.wotonomy.foundation/src/main/java/net/wotonomy/foundation/xml/XMLDecoder.java b/projects/net.wotonomy.foundation/src/main/java/net/wotonomy/foundation/xml/XMLDecoder.java index 64ac4b2..79b3967 100644 --- a/projects/net.wotonomy.foundation/src/main/java/net/wotonomy/foundation/xml/XMLDecoder.java +++ b/projects/net.wotonomy.foundation/src/main/java/net/wotonomy/foundation/xml/XMLDecoder.java @@ -22,47 +22,42 @@ import java.io.InputStream; import java.net.URL; /** -* Defines an interface for classes that can de-serialize -* java objects from an XML representation. -*/ -public interface XMLDecoder -{ - /** - * Decodes an object from the specified input stream. - * @param anInputStream The input stream from which to read. - * The stream will be read fully. - * @param aDescription A description to accompany error messages - * for the stream, typically a file name. - * @param aURL A URL against which relative references within the - * XML will be resolved. - * @return The object that was constructed from the XML content, - * or null if no object could be constructed. - */ - public Object decode( - InputStream anInputStream, String aDescription, URL aURL ); + * Defines an interface for classes that can de-serialize java objects from an + * XML representation. + */ +public interface XMLDecoder { + /** + * Decodes an object from the specified input stream. + * + * @param anInputStream The input stream from which to read. The stream will be + * read fully. + * @param aDescription A description to accompany error messages for the + * stream, typically a file name. + * @param aURL A URL against which relative references within the XML + * will be resolved. + * @return The object that was constructed from the XML content, or null if no + * object could be constructed. + */ + public Object decode(InputStream anInputStream, String aDescription, URL aURL); } /* - * $Log$ - * Revision 1.1 2006/02/18 22:21:10 cgruber - * Add in simple xml interfaces from net.wotonomy.xml project. - * Add cobertura.ser to .cvsignore. God I wish sourceforge would move on this subversion thing... + * $Log$ Revision 1.1 2006/02/18 22:21:10 cgruber Add in simple xml interfaces + * from net.wotonomy.xml project. Add cobertura.ser to .cvsignore. God I wish + * sourceforge would move on this subversion thing... * - * Revision 1.1 2006/02/16 13:22:22 cgruber - * Check in all sources in eclipse-friendly maven-enabled packages. + * Revision 1.1 2006/02/16 13:22:22 cgruber Check in all sources in + * eclipse-friendly maven-enabled packages. * - * Revision 1.2 2001/02/06 14:34:23 mpowers - * Forgot to rename the package declarations. + * Revision 1.2 2001/02/06 14:34:23 mpowers Forgot to rename the package + * declarations. * - * Revision 1.1 2001/02/06 14:31:19 mpowers - * Moving XML utilities from util to xml package. + * Revision 1.1 2001/02/06 14:31:19 mpowers Moving XML utilities from util to + * xml package. * - * Revision 1.1.1.1 2000/12/21 15:52:33 mpowers - * Contributing wotonomy. + * Revision 1.1.1.1 2000/12/21 15:52:33 mpowers Contributing wotonomy. * - * Revision 1.2 2000/12/20 16:25:48 michael - * Added log to all files. + * Revision 1.2 2000/12/20 16:25:48 michael Added log to all files. * * */ - diff --git a/projects/net.wotonomy.foundation/src/main/java/net/wotonomy/foundation/xml/XMLEncoder.java b/projects/net.wotonomy.foundation/src/main/java/net/wotonomy/foundation/xml/XMLEncoder.java index e543bca..0d180aa 100644 --- a/projects/net.wotonomy.foundation/src/main/java/net/wotonomy/foundation/xml/XMLEncoder.java +++ b/projects/net.wotonomy.foundation/src/main/java/net/wotonomy/foundation/xml/XMLEncoder.java @@ -21,41 +21,37 @@ package net.wotonomy.foundation.xml; import java.io.OutputStream; /** -* Defines an interface for classes that can serialize -* an arbitrary java object into XML format. -*/ -public interface XMLEncoder -{ - /** - * Encodes an object to the specified output stream as XML. - * @param anObject The object to be serialized to XML format. - * @param anOutputStream The output stream to which the object - * will be written. The stream will not be flushed nor closed. - */ - public void encode( Object anObject, OutputStream anOutputStream ); + * Defines an interface for classes that can serialize an arbitrary java object + * into XML format. + */ +public interface XMLEncoder { + /** + * Encodes an object to the specified output stream as XML. + * + * @param anObject The object to be serialized to XML format. + * @param anOutputStream The output stream to which the object will be written. + * The stream will not be flushed nor closed. + */ + public void encode(Object anObject, OutputStream anOutputStream); } /* - * $Log$ - * Revision 1.1 2006/02/18 22:21:10 cgruber - * Add in simple xml interfaces from net.wotonomy.xml project. - * Add cobertura.ser to .cvsignore. God I wish sourceforge would move on this subversion thing... + * $Log$ Revision 1.1 2006/02/18 22:21:10 cgruber Add in simple xml interfaces + * from net.wotonomy.xml project. Add cobertura.ser to .cvsignore. God I wish + * sourceforge would move on this subversion thing... * - * Revision 1.1 2006/02/16 13:22:22 cgruber - * Check in all sources in eclipse-friendly maven-enabled packages. + * Revision 1.1 2006/02/16 13:22:22 cgruber Check in all sources in + * eclipse-friendly maven-enabled packages. * - * Revision 1.2 2001/02/06 14:34:23 mpowers - * Forgot to rename the package declarations. + * Revision 1.2 2001/02/06 14:34:23 mpowers Forgot to rename the package + * declarations. * - * Revision 1.1 2001/02/06 14:31:19 mpowers - * Moving XML utilities from util to xml package. + * Revision 1.1 2001/02/06 14:31:19 mpowers Moving XML utilities from util to + * xml package. * - * Revision 1.1.1.1 2000/12/21 15:52:33 mpowers - * Contributing wotonomy. + * Revision 1.1.1.1 2000/12/21 15:52:33 mpowers Contributing wotonomy. * - * Revision 1.2 2000/12/20 16:25:48 michael - * Added log to all files. + * Revision 1.2 2000/12/20 16:25:48 michael Added log to all files. * * */ - -- cgit v1.2.3