svn commit: r14300 - trunk/src/app/src/org/argouml/persistence/UmlFilePersister.java

Author: tfmorris
Date: 2008-04-06 18:57:20-0700
New Revision: 14300

Modified:
   trunk/src/app/src/org/argouml/persistence/UmlFilePersister.java

Log:
Add Javadoc.  Reduce visibility of method only used here and in subclass

Modified: trunk/src/app/src/org/argouml/persistence/UmlFilePersister.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/app/src/org/argouml/persistence/UmlFilePersister.java?view=diff&rev=14300&p1=trunk/src/app/src/org/argouml/persistence/UmlFilePersister.java&p2=trunk/src/app/src/org/argouml/persistence/UmlFilePersister.java&r1=14299&r2=14300
==============================================================================
--- trunk/src/app/src/org/argouml/persistence/UmlFilePersister.java	(original)
+++ trunk/src/app/src/org/argouml/persistence/UmlFilePersister.java	2008-04-06 18:57:20-0700
@@ -332,11 +332,10 @@
         return doLoad(file, file, progressMgr);
     }
 
-    /*
-     * @see org.argouml.persistence.ProjectFilePersister#doLoad(java.io.File)
-     */
-    public Project doLoad(File originalFile, File file, ProgressMgr progressMgr)
-        throws OpenException, InterruptedException {
+
+    protected Project doLoad(File originalFile, File file,
+            ProgressMgr progressMgr) throws OpenException, 
+            InterruptedException {
 
         XmlInputStream inputStream = null;
         try {
@@ -429,7 +428,7 @@
     }
 
     protected boolean checkVersion(int fileVersion, String releaseVersion)
-            throws OpenException, VersionException {
+        throws OpenException, VersionException {
         // If we're trying to load a file from a future version
         // complain and refuse.
         if (fileVersion > PERSISTENCE_VERSION) {
@@ -539,7 +538,8 @@
      * @throws OpenException on any error
      */
     protected int getPersistenceVersion(InputStream inputStream)
-            throws OpenException {
+        throws OpenException {
+        
         BufferedReader reader = null;
         try {
             reader = new BufferedReader(new InputStreamReader(inputStream, 
@@ -606,7 +606,8 @@
      * @throws OpenException on any error
      */
     protected String getReleaseVersion(InputStream inputStream)
-            throws OpenException {
+        throws OpenException {
+
         BufferedReader reader = null;
         try {
             reader = new BufferedReader(new InputStreamReader(inputStream, 
@@ -736,11 +737,25 @@
         private final Pattern pattern = Pattern.compile(
                 "\\s*<\\?xml.*\\?>\\s*(<!DOCTYPE.*>\\s*)?");
 
+        /**
+         * Construct a filtered output stream using the given character set 
+         * name.
+         * 
+         * @param outputStream source output stream to filter
+         * @param charsetName name of character set to use for encoding
+         */
         public XmlFilterOutputStream(OutputStream outputStream,
                 String charsetName) {
             this(outputStream, Charset.forName(charsetName));
         }
 
+        /**
+         * Construct a filtered output stream using the given character set 
+         * name.
+         * 
+         * @param outputStream source output stream to filter
+         * @param charset character set to use for encoding
+         */
         public XmlFilterOutputStream(OutputStream outputStream, 
                 Charset charset) {
             super(outputStream);
@@ -750,6 +765,9 @@
             startEntry();
         }  
         
+        /**
+         * Reset processing for the beginning of an entry.
+         */
         public void startEntry() {
             headerProcessed = false;
             resetBuffers();