Undo overzealous reindentation.

I went overboard while trying to make things more readable. That can wait for another time. Some minor rewrapping, punctuation, etc. of comments stands.
2025-10-08 02:24:18 +00:00 · 2012-11-05 15:26:24 -05:00
parent 96b39c81af
commit 96a577dbfd
14 changed files with 5222 additions and 1391 deletions
--- a/dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java
@@ -375,12 +375,10 @@ public class MetadataUtilities {
    }
    
    /**
-     * rewrite of ItemImport's functionality
+     * Rewrite of ItemImport's functionality
     * but just the parsing of the file, not the processing of its elements.
     *      
-     * @param f file of item metadata.
-     * @validate  flag to verify matching files in tree.
-     * @return parsed content of {@code f}.
+     * @validate  flag to verify matching files in tree
     */
    public static List<ContentsEntry> readContentsFile(File f)
    throws FileNotFoundException, IOException, ParseException
@@ -503,8 +501,8 @@ public class MetadataUtilities {
 	}
 	
 	/**
-     *    Parses metadata field given in the form "<schema>.<element>[.<qualifier>|.*]".
-     *    Checks for correct number of elements (2 or 3) and for empty strings.
+	 *    Parses metadata field given in the form <schema>.<element>[.<qualifier>|.*]
+	 *    checks for correct number of elements (2 or 3) and for empty strings
 	 *    
 	 *    @return String Array
 	 *    @throws ParseException if validity checks fail
--- a/dspace-api/src/main/java/org/dspace/browse/BrowseIndex.java
+++ b/dspace-api/src/main/java/org/dspace/browse/BrowseIndex.java
@@ -75,7 +75,7 @@ public final class BrowseIndex
    }
    
    /**
-     * Constructor for creating generic / internal index objects.
+     * Constructor for creating generic / internal index objects
     * @param baseName The base of the table name
     */
    private BrowseIndex(String baseName)
@@ -369,6 +369,7 @@ public final class BrowseIndex
     * @param baseName
     * @param isDistinct
     * @param isMap
+     * @return
     */
    private static String getSequenceName(String baseName, boolean isDistinct, boolean isMap)
    {
@@ -411,7 +412,7 @@ public final class BrowseIndex
     * @param isCollection
     * @param isDistinct
     * @param isMap
-     * @return the name of the table.
+     * @return
     */
    private static String getTableName(String baseName, boolean isCommunity, boolean isCollection, boolean isDistinct, boolean isMap)
    {
@@ -442,7 +443,7 @@ public final class BrowseIndex
    }
    
    /**
-     * Get the name of the table in the given circumstances.
+     * Get the name of the table in the given circumstances
     * 
     * @param isCommunity	whether this is a community constrained index (view)
     * @param isCollection	whether this is a collection constrained index (view)
@@ -484,8 +485,6 @@ public final class BrowseIndex
     * <code>
     * getTableName(false, false, false, false);
     * </code>
-     * 
-     * @return the name of the table.
     */
    public String getTableName()
    {
@@ -493,7 +492,7 @@ public final class BrowseIndex
    }
    
    /**
-     * Get the table name for the given set of circumstances
+     * Get the table name for the given set of circumstances.
     * 
     * This is the same as calling:
     * 
@@ -504,7 +503,6 @@ public final class BrowseIndex
     * @param isDistinct	is this a distinct table
     * @param isCommunity
     * @param isCollection
-     * @return the name of the table.
     * @deprecated 1.5
     */
    public String getTableName(boolean isDistinct, boolean isCommunity, boolean isCollection)
@@ -518,8 +516,6 @@ public final class BrowseIndex
     * <code>
     * getTableName(false, false, false, true);
     * </code>
-     * 
-     * @return the name of the table.
     */
    public String getMapTableName()
    {
@@ -532,8 +528,6 @@ public final class BrowseIndex
     * <code>
     * getTableName(false, false, true, false);
     * </code>
-     *
-     * @return the name of the table.
     */
    public String getDistinctTableName()
    {
@@ -629,7 +623,6 @@ public final class BrowseIndex
    
    /**
     * Get the field for sorting associated with this index.
-     * @return the name of the field.
     * @throws BrowseException
     */
    public String getSortField(boolean isSecondLevel) throws BrowseException
@@ -655,11 +648,7 @@ public final class BrowseIndex
    }
    
    /**
-     * Get an array of the names of all the browse index tables in the current
-     * configuration.
-     *
     * @deprecated
-     * @return names of all the current browse index tables.
     * @throws BrowseException
     */
    public static String[] tables()
@@ -730,10 +719,9 @@ public final class BrowseIndex
    }
    
    /**
-     * Get the configured browse index that is defined to use this sort option
+     * Get the configured browse index that is defined to use this sort option.
     * 
     * @param so
-     * @return the associated BrowseIndex.
     * @throws BrowseException
     */
    public static BrowseIndex getBrowseIndex(SortOption so) throws BrowseException
--- a/dspace-api/src/main/java/org/dspace/browse/BrowseItem.java
+++ b/dspace-api/src/main/java/org/dspace/browse/BrowseItem.java
@@ -160,7 +160,6 @@ public class BrowseItem extends DSpaceObject
 	/**
 	 * @deprecated
 	 * @param real
-     * @return real type, or Constants.ITEM.
 	 */
 	public int getType(boolean real)
 	{
--- a/dspace-api/src/main/java/org/dspace/browse/CrossLinks.java
+++ b/dspace-api/src/main/java/org/dspace/browse/CrossLinks.java
@@ -26,7 +26,7 @@ public class CrossLinks
 	private Map<String, String> links = new HashMap<String, String>();
 	
 	/**
-     * Construct a new object which will obtain the configuration for itself
+	 * Construct a new object which will obtain the configuration for itself.
 	 * 
 	 * @throws BrowseException
 	 */
@@ -54,8 +54,7 @@ public class CrossLinks
 	}

 	/**
-     * Is there a link for the given canonical form of metadata (i.e.
-     * schema.element.qualifier)?
+	 * Is there a link for the given canonical form of metadata (i.e. schema.element.qualifier)?
 	 * 
 	 * @param metadata	the metadata to check for a link on
 	 */
@@ -65,7 +64,7 @@ public class CrossLinks
 	}
 	
 	/**
-     * get the type of link that the bit of metadata has.
+	 * Get the type of link that the bit of metadata has.
 	 * 
 	 * @param metadata	the metadata to get the link type for
 	 */
--- a/dspace-api/src/main/java/org/dspace/browse/IndexBrowse.java
+++ b/dspace-api/src/main/java/org/dspace/browse/IndexBrowse.java
@@ -599,7 +599,6 @@ public class IndexBrowse
 	 * remove all the indices for the given item
 	 * 
 	 * @param item		the item to be removed
-     * @return true if removed.
 	 * @throws BrowseException
 	 */
 	public boolean itemRemoved(Item item)
--- a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAO.java
+++ b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAO.java
@@ -48,10 +48,9 @@ public interface ItemCountDAO
 	public void collectionCount(Collection collection, int count) throws ItemCountException;
 	
 	/**
-     * Get the number of items in the given DSpaceObject container.
-     * This method will only succeed if the DSpaceObject is an instance of
-     * either a Community or a Collection.  Otherwise it will throw an
-     * exception.
+	 * Get the number of items in the given DSpaceObject container.  This method will
+	 * only succeed if the DSpaceObject is an instance of either a Community or a
+	 * Collection.  Otherwise it will throw an exception.
 	 * 
 	 * @param dso
 	 * @throws ItemCountException
--- a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOOracle.java
+++ b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOOracle.java
@@ -155,7 +155,7 @@ public class ItemCountDAOOracle implements ItemCountDAO
 	}

 	/**
-     * get the count of the items in the given container.
+	 * Get the count of the items in the given container.
 	 * 
 	 * @param dso
 	 * @throws ItemCountException
@@ -289,6 +289,7 @@ public class ItemCountDAOOracle implements ItemCountDAO
 	 * get the count for the given community
 	 * 
 	 * @param community
+	 * @return
 	 * @throws ItemCountException
 	 */
 	private int getCommunityCount(Community community)
--- a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOPostgres.java
+++ b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOPostgres.java
@@ -155,7 +155,7 @@ public class ItemCountDAOPostgres implements ItemCountDAO
 	}

 	/**
-     * get the count of the items in the given container
+	 * Get the count of the items in the given container.
 	 * 
 	 * @param dso
 	 * @throws ItemCountException
@@ -245,6 +245,7 @@ public class ItemCountDAOPostgres implements ItemCountDAO
 	 * Get the count for the given collection
 	 * 
 	 * @param collection
+	 * @return
 	 * @throws ItemCountException
 	 */
 	private int getCollectionCount(Collection collection)
@@ -288,6 +289,7 @@ public class ItemCountDAOPostgres implements ItemCountDAO
 	 * get the count for the given community
 	 * 
 	 * @param community
+	 * @return
 	 * @throws ItemCountException
 	 */
 	private int getCommunityCount(Community community)
--- a/dspace-api/src/main/java/org/dspace/browse/ItemCounter.java
+++ b/dspace-api/src/main/java/org/dspace/browse/ItemCounter.java
@@ -66,6 +66,7 @@ public class ItemCounter
 	 */
 	public ItemCounter(Context context)
 		throws ItemCountException
+		
 	{
 		this.context = context;
 		this.dao = ItemCountDAOFactory.getInstance(this.context);
@@ -100,7 +101,7 @@ public class ItemCounter
 	 * Get the count of the items in the given container.  If the configuration
 	 * value webui.strengths.cache is equal to 'true' this will return the
 	 * cached value if it exists.  If it is equal to 'false' it will count
-     * the number of items in the container in real time
+	 * the number of items in the container in real time.
 	 * 
 	 * @param dso
 	 * @throws ItemCountException
--- a/dspace-api/src/main/java/org/dspace/browse/ItemListConfig.java
+++ b/dspace-api/src/main/java/org/dspace/browse/ItemListConfig.java
@@ -95,7 +95,7 @@ public class ItemListConfig
 	}
 	
 	/**
-     * what metadata is to go in the given column number
+	 * What metadata is to go in the given column number?
 	 * 
 	 * @param col
 	 */
--- a/dspace-api/src/main/java/org/dspace/harvest/HarvestedCollection.java
+++ b/dspace-api/src/main/java/org/dspace/harvest/HarvestedCollection.java
@@ -43,13 +43,13 @@ public class HarvestedCollection
 	
 	/*
 	 * 	collection_id      | integer                  | not null
-     *  harvest_type       | integer                  | 
-     *  oai_source         | text                     | 
-     *	oai_set_id         | text                     | 
-     *	harvest_message    | text                     | 
-     *	metadata_config_id | text                     | 
-     *	harvest_status     | integer                  | 
-     *	harvest_start_time | timestamp with time zone | 
+ 		harvest_type       | integer                  | 
+ 		oai_source         | text                     | 
+ 		oai_set_id         | text                     | 
+ 		harvest_message    | text                     | 
+ 		metadata_config_id | text                     | 
+ 		harvest_status     | integer                  | 
+ 		harvest_start_time | timestamp with time zone | 
 	 */  
 	
 	// TODO: make sure this guy knows to lock people out if the status is not zero.
@@ -212,10 +212,9 @@ public class HarvestedCollection
    }
    
    /**
-     * Find all collections with the specified status flag 
+     * Find all collections with the specified status flag.
     * @param c
     * @param status see HarvestInstance.STATUS_...
-     * @return matching Collection IDs.
     * @throws SQLException
     */
    public static List<Integer> findByStatus(Context c, int status) throws SQLException {
--- a/mvn.out
+++ b/mvn.out