donaldp 2002/11/11 19:02:08
Modified: info/src/java/org/apache/avalon/framework/tools/infobuilder
XMLInfoWriter.java
Log:
Add boiler plate javadocs
Revision Changes Path
1.2 +85 -1
jakarta-avalon-excalibur/info/src/java/org/apache/avalon/framework/tools/infobuilder/XMLInfoWriter.java
Index: XMLInfoWriter.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/info/src/java/org/apache/avalon/framework/tools/infobuilder/XMLInfoWriter.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XMLInfoWriter.java 12 Nov 2002 01:22:45 -0000 1.1
+++ XMLInfoWriter.java 12 Nov 2002 03:02:08 -0000 1.2
@@ -33,6 +33,13 @@
{
private static final String CONTEXT_CLASS =
"org.apache.avalon.framework.context.Context";
+ /**
+ * Write out info representation to xml.
+ *
+ * @param info the info object
+ * @param outputStream the stream to write to
+ * @throws IOException if unable to write xml
+ */
public void writeServiceInfo( final ServiceInfo info,
final OutputStream outputStream )
throws Exception
@@ -40,6 +47,13 @@
throw new UnsupportedOperationException();
}
+ /**
+ * Write out info representation to xml.
+ *
+ * @param info the info object
+ * @param outputStream the stream to write to
+ * @throws IOException if unable to write xml
+ */
public void writeComponentInfo( final ComponentInfo info,
final OutputStream outputStream )
throws Exception
@@ -63,6 +77,13 @@
writer.write( "<?xml version=\"1.0\" ?>" );
}
+ /**
+ * Write out DOCType delcaration.
+ *
+ * @param writer the writer
+ * @param root the root name of document
+ * @throws IOException if unable to write xml
+ */
private void writeDoctype( final Writer writer,
final String root )
throws IOException
@@ -74,6 +95,13 @@
writer.write( doctype );
}
+ /**
+ * Write out xml representation of a component.
+ *
+ * @param writer the writer
+ * @param component the component
+ * @throws IOException if unable to write xml
+ */
private void writeComponent( final Writer writer,
final ComponentDescriptor component )
throws IOException
@@ -93,6 +121,13 @@
}
}
+ /**
+ * Write out xml representation of a set of loggers.
+ *
+ * @param writer the writer
+ * @param loggers the loggers
+ * @throws IOException if unable to write xml
+ */
private void writeLoggers( final Writer writer,
final LoggerDescriptor[] loggers )
throws IOException
@@ -106,6 +141,13 @@
writer.write( "</loggers>" );
}
+ /**
+ * Write out xml representation of a logger.
+ *
+ * @param writer the writer
+ * @param logger the logger
+ * @throws IOException if unable to write xml
+ */
private void writeLogger( final Writer writer,
final LoggerDescriptor logger )
throws IOException
@@ -125,6 +167,13 @@
}
}
+ /**
+ * Write out xml representation of a context.
+ *
+ * @param writer the writer
+ * @param context the context
+ * @throws IOException if unable to write xml
+ */
private void writeContext( final Writer writer,
final ContextDescriptor context )
throws IOException
@@ -159,6 +208,13 @@
writer.write( "</context>" );
}
+ /**
+ * Write out xml representation of an entry.
+ *
+ * @param writer the writer
+ * @param entry the entry
+ * @throws IOException if unable to write xml
+ */
private void writeEntry( final Writer writer,
final EntryDescriptor entry )
throws IOException
@@ -186,6 +242,13 @@
}
}
+ /**
+ * Write out xml representation of a set of services.
+ *
+ * @param writer the writer
+ * @param services the services
+ * @throws IOException if unable to write xml
+ */
private void writeServices( final Writer writer,
final ServiceDescriptor[] services )
throws IOException
@@ -211,6 +274,13 @@
writer.write( "</services>" );
}
+ /**
+ * Write out xml representation of a set of dependencies.
+ *
+ * @param writer the writer
+ * @param dependencies the dependencies
+ * @throws IOException if unable to write xml
+ */
private void writeDependencies( final Writer writer,
final DependencyDescriptor[] dependencies )
throws IOException
@@ -251,6 +321,13 @@
writer.write( "</dependencies>" );
}
+ /**
+ * Write out xml representation of a set of attributes.
+ *
+ * @param writer the writer
+ * @param attributes the attributes
+ * @throws IOException if unable to write xml
+ */
private void writeAttributes( final Writer writer,
final Attribute[] attributes )
throws IOException
@@ -261,6 +338,13 @@
}
}
+ /**
+ * Write out xml representation of an attribute.
+ *
+ * @param writer the writer
+ * @param attribute the attribute
+ * @throws IOException if unable to write xml
+ */
private void writeAttribute( final Writer writer,
final Attribute attribute )
throws IOException
--
To unsubscribe, e-mail: <mailto:avalon-cvs-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@;jakarta.apache.org>
