hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-12 12:33:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up dspace-api doc comment warnings

Browse Source
This commit is contained in:
Mark H. Wood
2012-11-02 16:08:00 -04:00
parent 3cf7c59780
commit 255288a367
51 changed files with 1519 additions and 1678 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
dspace-api/src/main/java/org/dspace/app/itemexport/ItemExport.java
View File

@@ -1128,11 +1128,10 @@ public class ItemExport
}
/**
* Get the file size of the export archive represented by the file name
* Get the file size of the export archive represented by the file name.
*
* @param fileName
* name of the file to get the size
* @return
* name of the file to get the size.
* @throws Exception
*/
public static long getExportFileSize(String fileName) throws Exception

13
dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java
View File

@@ -376,11 +376,11 @@ public class MetadataUtilities {
/**
* rewrite of ItemImport's functionality
* but just the parsing of the file, not the processing of its elements
* but just the parsing of the file, not the processing of its elements.
*
*
* @validate flag to verify matching files in tree
* @return
* @param f file of item metadata.
* @validate flag to verify matching files in tree.
* @return parsed content of {@code f}.
*/
public static List<ContentsEntry> readContentsFile(File f)
throws FileNotFoundException, IOException, ParseException
@@ -423,7 +423,6 @@ public class MetadataUtilities {
/**
*
* @param f
* @return
* @throws FileNotFoundException
* @throws IOException
*/
@@ -504,8 +503,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

5
dspace-api/src/main/java/org/dspace/app/packager/Packager.java
View File

@@ -608,7 +608,6 @@ public class Packager
* @param dso DSpace Object to disseminate as a package
* @param pkgParams Parameters to pass to individual packager instances
* @param outputFile File where final package should be saved
* @param identifier identifier of main DSpace object to disseminate
* @throws IOException
* @throws SQLException
* @throws FileNotFoundException
@@ -616,7 +615,9 @@ public class Packager
* @throws CrosswalkException
* @throws PackageException
*/
protected void disseminate(Context context, PackageDisseminator dip, DSpaceObject dso, PackageParameters pkgParams, String outputFile)
protected void disseminate(Context context, PackageDisseminator dip,
DSpaceObject dso, PackageParameters pkgParams,
String outputFile)
throws IOException, SQLException, FileNotFoundException, AuthorizeException, CrosswalkException, PackageException
{
// initialize output file

8
dspace-api/src/main/java/org/dspace/app/sfx/SFXFileReader.java
View File

@@ -94,11 +94,11 @@ public class SFXFileReader {
}
/**
* Process the item
* Process the item.
*
* @param node
* @param item
* @return
* @return processed fields.
* @throws IOException
*/
public static String doNodes(Node node, Item item) throws IOException
@@ -135,11 +135,11 @@ public class SFXFileReader {
}
/**
* Process the fields
* Process the fields.
*
* @param e
* @param item
* @return
* @return assembled query.
* @throws IOException
*/
private static String processFields(Node e, Item item) throws IOException

6
dspace-api/src/main/java/org/dspace/app/statistics/LogAnalyser.java
View File

@@ -855,9 +855,7 @@ public class LogAnalyser
}
/**
* read in the given config file and populate the class globals
*
* @param configFile the config file to read in
* Read in the current config file and populate the class globals.
*/
public static void readConfig() throws IOException
{
@@ -865,7 +863,7 @@ public class LogAnalyser
}
/**
* read in the given config file and populate the class globals
* Read in the given config file and populate the class globals.
*
* @param configFile the config file to read in
*/

41
dspace-api/src/main/java/org/dspace/app/statistics/StatisticsLoader.java
View File

@@ -53,8 +53,7 @@ public class StatisticsLoader
}
/**
* Get an array of the dates of the report files
* @return
* Get an array of the dates of the report files.
*/
public static Date[] getMonthlyReportDates()
{
@@ -62,8 +61,7 @@ public class StatisticsLoader
}
/**
* Get an array of the dates of the analysis files
* @return
* Get an array of the dates of the analysis files.
*/
public static Date[] getMonthlyAnalysisDates()
{
@@ -71,9 +69,8 @@ public class StatisticsLoader
}
/**
* Convert the formatted dates that are the keys of the map into a date array
* Convert the formatted dates that are the keys of the map into a date array.
* @param monthlyMap
* @return
*/
protected static Date[] getDatesFromMap(Map<String, StatsFile> monthlyMap)
{
@@ -97,9 +94,9 @@ public class StatisticsLoader
}
/**
* Sort the date array in descending (reverse chronological) order
* Sort the date array in descending (reverse chronological) order.
* @param dates
* @return
* @return sorted dates.
*/
protected static Date[] sortDatesDescending(Date[] dates)
{
@@ -134,9 +131,8 @@ public class StatisticsLoader
}
/**
* Get the analysis file for a given date
* Get the analysis file for a given date.
* @param date
* @return
*/
public static File getAnalysisFor(String date)
{
@@ -146,9 +142,8 @@ public class StatisticsLoader
}
/**
* Get the report file for a given date
* Get the report file for a given date.
* @param date
* @return
*/
public static File getReportFor(String date)
{
@@ -158,8 +153,7 @@ public class StatisticsLoader
}
/**
* Get the current general analysis file
* @return
* Get the current general analysis file.
*/
public static File getGeneralAnalysis()
{
@@ -168,8 +162,7 @@ public class StatisticsLoader
}
/**
* Get the current general report file
* @return
* Get the current general report file.
*/
public static File getGeneralReport()
{
@@ -295,13 +288,13 @@ public class StatisticsLoader
}
/**
* Generate a StatsFile entry for this file. The pattern and date formatters are used to
* identify the file as a particular type, and extract the relevant information.
* If the file is not identified by the formatter provided, then we return null
* Generate a StatsFile entry for this file. The pattern and date
* formatters are used to identify the file as a particular type,
* and extract the relevant information. If the file is not identified
* by the formatter provided, then we return null.
* @param thisFile
* @param thisPattern
* @param sdf
* @return
*/
private static StatsFile makeStatsFile(File thisFile, Pattern thisPattern, SimpleDateFormat sdf)
{
@@ -329,8 +322,7 @@ public class StatisticsLoader
}
/**
* Get an array of all the analysis and report files
* @return
* Get an array of all the analysis and report files.
*/
private static File[] getAnalysisAndReportFileList()
{
@@ -344,7 +336,7 @@ public class StatisticsLoader
}
/**
* Simple class for holding information about an analysis/report file
* Simple class for holding information about an analysis/report file.
*/
private static class StatsFile
{
@@ -355,7 +347,8 @@ public class StatisticsLoader
}
/**
* Filter used to restrict files in the reports directory to just analysis or report types
* Filter used to restrict files in the reports directory to just
* analysis or report types.
*/
private static class AnalysisAndReportFilter implements FilenameFilter
{

35
dspace-api/src/main/java/org/dspace/app/statistics/package.html
View File

@@ -11,37 +11,6 @@
<html>
<head>
<title>org.dspace.app.statistics package</title>
<!--
* Copyright (c) 2002-2009, The DSpace Foundation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of the DSpace Foundation nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
* USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
-->
</head>
<body>
@@ -67,11 +36,11 @@ class, defined in this package, to select an event processing implementation.
Three "stock" implementations are provided.
</p>
<dl>
<dt>{@link org.dspace.app.statistics.PassiveUsageEvent PassiveUsageEvent}</dt>
<dt>{@link org.dspace.usage.PassiveUsageEventListener PassiveUsageEventListener}</dt>
<dd>absorbs events without taking action, resulting in behavior identical
to that of DSpace before this package was added. This is the default
if no plugin is configured.</dd>
<dt>{@link org.dspace.app.statistics.UsageEventTabFileLogger UsageEventTabFileLogger}</dt>
<dt>{@link org.dspace.usage.TabFileUsageEventListener TabFileUsageEventListener}</dt>
<dd>writes event records to a file in Tab Separated Values format.</dd>
<dt>{@link org.dspace.app.statistics.UsageEventXMLLogger UsageEventXMLLogger}</dt>
<dd>writes event records to a file in an XML format. Suitable mainly for

1
dspace-api/src/main/java/org/dspace/app/util/DCInput.java
View File

@@ -17,7 +17,6 @@ import org.dspace.content.MetadataSchema;
* Class representing a line in an input form.
*
* @author Brian S. Hughes, based on work by Jenny Toves, OCLC
* @version
*/
public class DCInput
{

1
dspace-api/src/main/java/org/dspace/app/util/GoogleMetadata.java
View File

@@ -772,7 +772,6 @@ public class GoogleMetadata
/**
* Produce meta elements that can easily be put into the head.
* @return
*/
public List<Element> disseminateList()
{

66
dspace-api/src/main/java/org/dspace/authorize/AuthorizeConfiguration.java
View File

@@ -174,8 +174,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to create new, not strictly community
* related, group?
*
* @return
*/
public static boolean canCommunityAdminPerformGroupCreation()
{
@@ -184,8 +182,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to create collections or subcommunities?
*
* @return
*/
public static boolean canCommunityAdminPerformSubelementCreation()
{
@@ -194,8 +190,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to remove collections or subcommunities?
*
* @return
*/
public static boolean canCommunityAdminPerformSubelementDeletion()
{
@@ -205,8 +199,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to manage the community's and
* subcommunities' policies?
*
* @return
*/
public static boolean canCommunityAdminManagePolicies()
{
@@ -216,8 +208,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to create/edit them community's and
* subcommunities' admin groups?
*
* @return
*/
public static boolean canCommunityAdminManageAdminGroup()
{
@@ -227,8 +217,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to create/edit the community's and
* subcommunities' admin group?
*
* @return
*/
public static boolean canCommunityAdminManageCollectionPolicies()
{
@@ -238,8 +226,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to manage the item template of them
* collections?
*
* @return
*/
public static boolean canCommunityAdminManageCollectionTemplateItem()
{
@@ -249,8 +235,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to manage (create/edit/remove) the
* submitters group of them collections?
*
* @return
*/
public static boolean canCommunityAdminManageCollectionSubmitters()
{
@@ -260,8 +244,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to manage (create/edit/remove) the workflows
* group of them collections?
*
* @return
*/
public static boolean canCommunityAdminManageCollectionWorkflows()
{
@@ -271,8 +253,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to manage (create/edit/remove) the admin
* group of them collections?
*
* @return
*/
public static boolean canCommunityAdminManageCollectionAdminGroup()
{
@@ -281,8 +261,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to remove an item from them collections?
*
* @return
*/
public static boolean canCommunityAdminPerformItemDeletion()
{
@@ -291,8 +269,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to withdrawn an item from them collections?
*
* @return
*/
public static boolean canCommunityAdminPerformItemWithdrawn()
{
@@ -302,8 +278,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to reinstate an item from them
* collections?
*
* @return
*/
public static boolean canCommunityAdminPerformItemReinstatiate()
{
@@ -313,8 +287,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to manage the policies of an item owned by
* one of them collections?
*
* @return
*/
public static boolean canCommunityAdminManageItemPolicies()
{
@@ -324,8 +296,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to add a bitstream to an item owned by one
* of them collections?
*
* @return
*/
public static boolean canCommunityAdminPerformBitstreamCreation()
{
@@ -335,8 +305,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to remove a bitstream from an item owned by
* one of them collections?
*
* @return
*/
public static boolean canCommunityAdminPerformBitstreamDeletion()
{
@@ -346,8 +314,6 @@ public class AuthorizeConfiguration
/**
* Are community admins allowed to perform CC License replace or addition to
* an item owned by one of them collections?
*
* @return
*/
public static boolean canCommunityAdminManageCCLicense()
{
@@ -356,8 +322,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to manage the collection's policies?
*
* @return
*/
public static boolean canCollectionAdminManagePolicies()
{
@@ -367,8 +331,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to manage (create/edit/delete) the
* collection's item template?
*
* @return
*/
public static boolean canCollectionAdminManageTemplateItem()
{
@@ -378,8 +340,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to manage (create/edit/delete) the
* collection's submitters group?
*
* @return
*/
public static boolean canCollectionAdminManageSubmitters()
{
@@ -389,8 +349,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to manage (create/edit/delete) the
* collection's workflows group?
*
* @return
*/
public static boolean canCollectionAdminManageWorkflows()
{
@@ -400,8 +358,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to manage (create/edit) the collection's
* admins group?
*
* @return
*/
public static boolean canCollectionAdminManageAdminGroup()
{
@@ -410,8 +366,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to remove an item from the collection?
*
* @return
*/
public static boolean canCollectionAdminPerformItemDeletion()
{
@@ -420,8 +374,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to withdrawn an item from the collection?
*
* @return
*/
public static boolean canCollectionAdminPerformItemWithdrawn()
{
@@ -431,8 +383,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to reinstate an item from the
* collection?
*
* @return
*/
public static boolean canCollectionAdminPerformItemReinstatiate()
{
@@ -442,8 +392,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to manage the policies of item owned by the
* collection?
*
* @return
*/
public static boolean canCollectionAdminManageItemPolicies()
{
@@ -453,8 +401,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to add a bitstream to an item owned by the
* collections?
*
* @return
*/
public static boolean canCollectionAdminPerformBitstreamCreation()
{
@@ -464,8 +410,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to remove a bitstream from an item owned by
* the collections?
*
* @return
*/
public static boolean canCollectionAdminPerformBitstreamDeletion()
{
@@ -475,8 +419,6 @@ public class AuthorizeConfiguration
/**
* Are collection admins allowed to replace or adding a CC License to an
* item owned by the collections?
*
* @return
*/
public static boolean canCollectionAdminManageCCLicense()
{
@@ -485,8 +427,6 @@ public class AuthorizeConfiguration
/**
* Are item admins allowed to manage the item's policies?
*
* @return
*/
public static boolean canItemAdminManagePolicies()
{
@@ -495,8 +435,6 @@ public class AuthorizeConfiguration
/**
* Are item admins allowed to add bitstreams to the item?
*
* @return
*/
public static boolean canItemAdminPerformBitstreamCreation()
{
@@ -505,8 +443,6 @@ public class AuthorizeConfiguration
/**
* Are item admins allowed to remove bitstreams from the item?
*
* @return
*/
public static boolean canItemAdminPerformBitstreamDeletion()
{
@@ -515,8 +451,6 @@ public class AuthorizeConfiguration
/**
* Are item admins allowed to replace or adding CC License to the item?
*
* @return
*/
public static boolean canItemAdminManageCCLicense()
{

2
dspace-api/src/main/java/org/dspace/browse/BrowseCreateDAO.java
View File

@@ -332,7 +332,7 @@ public interface BrowseCreateDAO
* @param table the name of the distinct table which holds the target of the mapping
* @param map the name of the mapping table itself
* @param execute whether to execute the query or not
* @return
* @return the instructions (SQL) which effect the creation.
* @throws BrowseException
*/
public String createDistinctMap(String table, String map, boolean execute) throws BrowseException;

24
dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtils.java
View File

@@ -8,8 +8,9 @@
package org.dspace.browse;
/**
* Utility class for retrieving the size of the columns to be used in the browse tables,
* and applying truncation to the strings that will be inserted into the tables.
* Utility class for retrieving the size of the columns to be used in the
* browse tables, and applying truncation to the strings that will be inserted
* into the tables.
*
* Can be configured in dspace.cfg, with the following entries:
*
@@ -25,9 +26,10 @@ package org.dspace.browse;
* - a string to append to truncated values that will be entered into
* the value columns (ie. '...')
*
* By default, the column sizes are '0' (unlimited), and no truncation is applied,
* EXCEPT for Oracle, where we have to truncate the columns for it to work! (in which
* case, both value and sort columns are by default limited to 2000 characters).
* By default, the column sizes are '0' (unlimited), and no truncation is
* applied, EXCEPT for Oracle, where we have to truncate the columns for it
* to work! (in which case, both value and sort columns are by default limited
* to 2000 characters).
*
* @author Graham Triggs
* @author Richard Jones
@@ -36,15 +38,11 @@ public interface BrowseDAOUtils
{
/**
* Get the size to use for the 'value' columns in characters
*
* @return
*/
public int getValueColumnMaxChars();
/**
* Get the size to use for the sort columns in characters
*
* @return
*/
public int getSortColumnMaxChars();
@@ -52,7 +50,7 @@ public interface BrowseDAOUtils
* Truncate strings that are to be used for the 'value' columns
*
* @param value
* @return
* @return the truncated value.
*/
public String truncateValue(String value);
@@ -60,7 +58,7 @@ public interface BrowseDAOUtils
* Truncate strings that are to be used for sorting
*
* @param value
* @return
* @return the truncated value.
*/
public String truncateSortValue(String value);
@@ -72,7 +70,7 @@ public interface BrowseDAOUtils
*
* @param value
* @param chars
* @return
* @return the truncated value.
* @deprecated
*/
public String truncateValue(String value, int chars);
@@ -85,7 +83,7 @@ public interface BrowseDAOUtils
*
* @param value
* @param chars
* @return
* @return the truncated value.
* @deprecated
*/
public String truncateSortValue(String value, int chars);

26
dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtilsDefault.java
View File

@@ -10,8 +10,9 @@ package org.dspace.browse;
import org.dspace.core.ConfigurationManager;
/**
* Utility class for retrieving the size of the columns to be used in the browse tables,
* and applying truncation to the strings that will be inserted into the tables.
* Utility class for retrieving the size of the columns to be used in the
* browse tables, and applying truncation to the strings that will be inserted
* into the tables.
*
* Can be configured in dspace.cfg, with the following entries:
*
@@ -27,9 +28,10 @@ import org.dspace.core.ConfigurationManager;
* - a string to append to truncated values that will be entered into
* the value columns (ie. '...')
*
* By default, the column sizes are '0' (unlimited), and no truncation is applied,
* EXCEPT for Oracle, where we have to truncate the columns for it to work! (in which
* case, both value and sort columns are by default limited to 2000 characters).
* By default, the column sizes are '0' (unlimited), and no truncation is
* applied, EXCEPT for Oracle, where we have to truncate the columns for it
* to work! (in which case, both value and sort columns are by default limited
* to 2000 characters).
*
* @author Graham Triggs
* @author Richard Jones
@@ -81,8 +83,6 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils
/**
* Get the size to use for the 'value' columns in characters
*
* @return
*/
public int getValueColumnMaxChars()
{
@@ -91,8 +91,6 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils
/**
* Get the size to use for the sort columns in characters
*
* @return
*/
public int getSortColumnMaxChars()
{
@@ -103,7 +101,7 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils
* Truncate strings that are to be used for the 'value' columns
*
* @param value
* @return
* @return the truncated value.
*/
public String truncateValue(String value)
{
@@ -114,7 +112,7 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils
* Truncate strings that are to be used for sorting
*
* @param value
* @return
* @return the truncated value.
*/
public String truncateSortValue(String value)
{
@@ -129,7 +127,7 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils
*
* @param value
* @param chars
* @return
* @return the truncated value.
* @deprecated
*/
public String truncateValue(String value, int chars)
@@ -145,7 +143,7 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils
*
* @param value
* @param chars
* @return
* @return the truncated value.
* @deprecated
*/
public String truncateSortValue(String value, int chars)
@@ -159,7 +157,7 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils
* @param value
* @param maxChars
* @param omissionMark
* @return
* @return the truncated value.
*/
private String trunctateString(String value, int maxChars, String omissionMark)
{

40
dspace-api/src/main/java/org/dspace/browse/BrowseIndex.java
View File

@@ -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,7 +369,6 @@ public final class BrowseIndex
* @param baseName
* @param isDistinct
* @param isMap
* @return
*/
private static String getSequenceName(String baseName, boolean isDistinct, boolean isMap)
{
@@ -412,7 +411,7 @@ public final class BrowseIndex
* @param isCollection
* @param isDistinct
* @param isMap
* @return
* @return the name of the table.
*/
private static String getTableName(String baseName, boolean isCommunity, boolean isCollection, boolean isDistinct, boolean isMap)
{
@@ -443,7 +442,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)
@@ -486,7 +485,7 @@ public final class BrowseIndex
* getTableName(false, false, false, false);
* </code>
*
* @return
* @return the name of the table.
*/
public String getTableName()
{
@@ -505,7 +504,7 @@ public final class BrowseIndex
* @param isDistinct is this a distinct table
* @param isCommunity
* @param isCollection
* @return
* @return the name of the table.
* @deprecated 1.5
*/
public String getTableName(boolean isDistinct, boolean isCommunity, boolean isCollection)
@@ -520,7 +519,7 @@ public final class BrowseIndex
* getTableName(false, false, false, true);
* </code>
*
* @return
* @return the name of the table.
*/
public String getMapTableName()
{
@@ -534,7 +533,7 @@ public final class BrowseIndex
* getTableName(false, false, true, false);
* </code>
*
* @return
* @return the name of the table.
*/
public String getDistinctTableName()
{
@@ -629,8 +628,8 @@ public final class BrowseIndex
}
/**
* Get the field for sorting associated with this index
* @return
* Get the field for sorting associated with this index.
* @return the name of the field.
* @throws BrowseException
*/
public String getSortField(boolean isSecondLevel) throws BrowseException
@@ -656,8 +655,11 @@ public final class BrowseIndex
}
/**
* Get an array of the names of all the browse index tables in the current
* configuration.
*
* @deprecated
* @return
* @return names of all the current browse index tables.
* @throws BrowseException
*/
public static String[] tables()
@@ -731,7 +733,7 @@ public final class BrowseIndex
* Get the configured browse index that is defined to use this sort option
*
* @param so
* @return
* @return the associated BrowseIndex.
* @throws BrowseException
*/
public static BrowseIndex getBrowseIndex(SortOption so) throws BrowseException
@@ -748,9 +750,7 @@ public final class BrowseIndex
}
/**
* Get the internally defined browse index for archived items
*
* @return
* Get the internally defined browse index for archived items.
*/
public static BrowseIndex getItemBrowseIndex()
{
@@ -758,8 +758,7 @@ public final class BrowseIndex
}
/**
* Get the internally defined browse index for withdrawn items
* @return
* Get the internally defined browse index for withdrawn items.
*/
public static BrowseIndex getWithdrawnBrowseIndex()
{
@@ -805,9 +804,7 @@ public final class BrowseIndex
}
/**
* Does this browse index represent one of the internal item indexes
*
* @return
* Does this browse index represent one of the internal item indexes?
*/
public boolean isInternalIndex()
{
@@ -815,9 +812,8 @@ public final class BrowseIndex
}
/**
* Generate a base table name
* Generate a base table name.
* @param number
* @return
*/
private static String makeTableBaseName(int number)
{

2
dspace-api/src/main/java/org/dspace/browse/BrowseInfo.java
View File

@@ -496,7 +496,7 @@ public class BrowseInfo
/**
* @deprecated
* @return
* @return an empty array of Item.
*/
public Item[] getItemResults()
{

3
dspace-api/src/main/java/org/dspace/browse/BrowseItem.java
View File

@@ -160,7 +160,7 @@ public class BrowseItem extends DSpaceObject
/**
* @deprecated
* @param real
* @return
* @return real type, or Constants.ITEM.
*/
public int getType(boolean real)
{
@@ -301,7 +301,6 @@ public class BrowseItem extends DSpaceObject
* rendering. That's your own fault for wanting to put images on your
* browse page!
*
* @return
* @throws SQLException
*/
public Thumbnail getThumbnail()

2
dspace-api/src/main/java/org/dspace/browse/BrowseItemDAO.java
View File

@@ -37,7 +37,7 @@ public interface BrowseItemDAO
* @param element
* @param qualifier
* @param lang
* @return
* @return matching metadata values.
* @throws SQLException
*/
public DCValue[] queryMetadata(int itemId, String schema, String element, String qualifier, String lang)

7
dspace-api/src/main/java/org/dspace/browse/CrossLinks.java
View File

@@ -54,10 +54,10 @@ 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
* @return
*/
public boolean hasLink(String metadata)
{
@@ -65,10 +65,9 @@ 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
* @return
*/
public String getLinkType(String metadata)
{

2
dspace-api/src/main/java/org/dspace/browse/IndexBrowse.java
View File

@@ -599,7 +599,7 @@ public class IndexBrowse
* remove all the indices for the given item
*
* @param item the item to be removed
* @return
* @return true if removed.
* @throws BrowseException
*/
public boolean itemRemoved(Item item)

8
dspace-api/src/main/java/org/dspace/browse/ItemCountDAO.java
View File

@@ -48,12 +48,12 @@ 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
* @return
* @throws ItemCountException
*/
public int getCount(DSpaceObject dso) throws ItemCountException;

1
dspace-api/src/main/java/org/dspace/browse/ItemCountDAOFactory.java
View File

@@ -24,7 +24,6 @@ public class ItemCountDAOFactory
* for the specific DSpace instance.
*
* @param context
* @return
* @throws ItemCountException
*/
public static ItemCountDAO getInstance(Context context)

4
dspace-api/src/main/java/org/dspace/browse/ItemCountDAOOracle.java
View File

@@ -155,10 +155,9 @@ 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
* @return
* @throws ItemCountException
*/
public int getCount(DSpaceObject dso)
@@ -290,7 +289,6 @@ public class ItemCountDAOOracle implements ItemCountDAO
* get the count for the given community
*
* @param community
* @return
* @throws ItemCountException
*/
private int getCommunityCount(Community community)

3
dspace-api/src/main/java/org/dspace/browse/ItemCountDAOPostgres.java
View File

@@ -158,7 +158,6 @@ public class ItemCountDAOPostgres implements ItemCountDAO
* get the count of the items in the given container
*
* @param dso
* @return
* @throws ItemCountException
*/
public int getCount(DSpaceObject dso)
@@ -246,7 +245,6 @@ public class ItemCountDAOPostgres implements ItemCountDAO
* Get the count for the given collection
*
* @param collection
* @return
* @throws ItemCountException
*/
private int getCollectionCount(Collection collection)
@@ -290,7 +288,6 @@ public class ItemCountDAOPostgres implements ItemCountDAO
* get the count for the given community
*
* @param community
* @return
* @throws ItemCountException
*/
private int getCommunityCount(Community community)

2
dspace-api/src/main/java/org/dspace/browse/ItemCounter.java
View File

@@ -66,7 +66,6 @@ public class ItemCounter
*/
public ItemCounter(Context context)
throws ItemCountException
{
this.context = context;
this.dao = ItemCountDAOFactory.getInstance(this.context);
@@ -104,7 +103,6 @@ public class ItemCounter
* the number of items in the container in real time
*
* @param dso
* @return
* @throws ItemCountException
* @throws SQLException
*/

1
dspace-api/src/main/java/org/dspace/browse/ItemListConfig.java
View File

@@ -98,7 +98,6 @@ public class ItemListConfig
* what metadata is to go in the given column number
*
* @param col
* @return
*/
public String[] getMetadata(int col)
{

2
dspace-api/src/main/java/org/dspace/checker/ChecksumHistory.java
View File

@@ -176,8 +176,6 @@ public class ChecksumHistory
/**
* Return the processing result.
*
* @return
*/
public String getResult()
{

1
dspace-api/src/main/java/org/dspace/checker/ResultsPruner.java
View File

@@ -110,7 +110,6 @@ public final class ResultsPruner
* properties.
*
* @param props
* @return
* @throws FileNotFoundException
*/
public static ResultsPruner getPruner(Properties props)

8
dspace-api/src/main/java/org/dspace/content/Bitstream.java
View File

@@ -686,9 +686,11 @@ public class Bitstream extends DSpaceObject
}
/**
* Get the parent object of a bitstream. It can either be an item if this is a normal
* bitstream, otherwise it could be a collection or a community if it is a logo.
* @return
* Get the parent object of a bitstream. The parent can be an item if this
* is a normal bitstream, or it could be a collection or a community if the
* bitstream is a logo.
*
* @return this bitstream's parent.
* @throws SQLException
*/
public DSpaceObject getParentObject() throws SQLException

14
dspace-api/src/main/java/org/dspace/content/LicenseUtils.java
View File

@@ -32,8 +32,8 @@ public class LicenseUtils
* Return the text of the license that the user has granted/must grant
* before for submit the item. The license text is build using the template
* defined for the collection if any or the wide site configuration. In the
* license text the following substitution can be used. {0} the eperson
* firstname<br>
* license text the following substitutions can be used.<br>
* {0} the eperson firstname<br>
* {1} the eperson lastname<br>
* {2} the eperson email<br>
* {3} the current date<br>
@@ -46,7 +46,7 @@ public class LicenseUtils
* {x} any addition argument supplied wrapped in the
* LicenseArgumentFormatter based on his type (map key)
*
* @see LicenseArgumentFormatter
* @see license.LicenseArgumentFormatter
* @param locale
* @param collection
* @param item
@@ -90,15 +90,15 @@ public class LicenseUtils
}
/**
* Utility method if no additional arguments has need to be supplied to the
* license template. (i.e. call the full getLicenseText supplying
* <code>null</code> for the additionalInfo argument)
* Utility method if no additional arguments are to be supplied to the
* license template. (equivalent to calling the full getLicenseText
* supplying {@code null} for the additionalInfo argument)
*
* @param locale
* @param collection
* @param item
* @param eperson
* @return
* @return the license text, with no custom substitutions.
*/
public static String getLicenseText(Locale locale, Collection collection,
Item item, EPerson eperson)

2
dspace-api/src/main/java/org/dspace/content/MetadataField.java
View File

@@ -661,7 +661,7 @@ public class MetadataField
* Return <code>true</code> if <code>other</code> is the same MetadataField
* as this object, <code>false</code> otherwise
*
* @param other
* @param obj
* object to compare to
*
* @return <code>true</code> if object passed in represents the same

10
dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSDisseminator.java
View File

@@ -213,11 +213,11 @@ public abstract class AbstractMETSDisseminator
* a failure creating the package.
*
* @param context DSpace context.
* @param object DSpace object (item, collection, etc)
* @param dso DSpace object (item, collection, etc)
* @param params Properties-style list of options specific to this packager
* @param pkgFile File where export package should be written
* @throws PackageValidationException if package cannot be created or there is
* a fatal error in creating it.
* @throws PackageValidationException if package cannot be created or there
* is a fatal error in creating it.
*/
@Override
public void disseminate(Context context, DSpaceObject dso,
@@ -1219,7 +1219,7 @@ public abstract class AbstractMETSDisseminator
* @param type - type attr value for the <div>
* @param dso - object for which to create the div
* @param params
* @return
* @return a new {@code Div} with {@code dso} as child.
*/
protected Div makeChildDiv(String type, DSpaceObject dso, PackageParameters params)
{
@@ -1394,7 +1394,7 @@ public abstract class AbstractMETSDisseminator
* @param context current DSpace Context
* @param params current Packager Parameters
* @param dso current DSpace Object
* @param ref the rightsMD <mdRef> element
* @param mdRef the rightsMD <mdRef> element
* @throws SQLException
* @throws IOException
* @throws AuthorizeException

6
dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSIngester.java
View File

@@ -1326,7 +1326,7 @@ public abstract class AbstractMETSIngester extends AbstractPackageIngester
* DSpace Context
* @param manifest
* METS manifest
* @returns a DSpace Object which is the parent (or null, if not found)
* @return a DSpace Object which is the parent (or null, if not found)
* @throws PackageValidationException
* if parent reference cannot be found in manifest
* @throws MetadataValidationException
@@ -1377,7 +1377,7 @@ public abstract class AbstractMETSIngester extends AbstractPackageIngester
*
* @param manifest
* METS manifest
* @returns handle as a string (or null, if not found)
* @return handle as a string (or null, if not found)
* @throws PackageValidationException
* if handle cannot be found in manifest
*/
@@ -1574,7 +1574,7 @@ public abstract class AbstractMETSIngester extends AbstractPackageIngester
/**
* Determines what type of DSpace object is represented in this METS doc.
*
* @returns one of the object types in Constants.
* @return one of the object types in Constants.
*/
public abstract int getObjectType(METSManifest manifest)
throws PackageValidationException;

2
dspace-api/src/main/java/org/dspace/content/packager/AbstractPackageDisseminator.java
View File

@@ -163,7 +163,7 @@ public abstract class AbstractPackageDisseminator
/**
* Add File to list of successfully disseminated package files
* @param file File
* @param f added File.
*/
protected void addToPackageList(File f)
{

6
dspace-api/src/main/java/org/dspace/content/packager/PackageParameters.java
View File

@@ -168,7 +168,6 @@ public class PackageParameters extends Properties
* Utility method to enable/disable workflow for Item ingestion.
*
* @param value boolean value (true = workflow enabled, false = workflow disabled)
* @return boolean result
*/
public void setWorkflowEnabled(boolean value)
{
@@ -212,7 +211,6 @@ public class PackageParameters extends Properties
* either skip-over (keep) or replace existing objects.
*
* @param value boolean value (true = restore enabled, false = restore disabled)
* @return boolean result
*/
public void setRestoreModeEnabled(boolean value)
{
@@ -244,7 +242,6 @@ public class PackageParameters extends Properties
* of "restore", where the current object is being restored to a previous state.
*
* @param value boolean value (true = replace enabled, false = replace disabled)
* @return boolean result
*/
public void setReplaceModeEnabled(boolean value)
{
@@ -276,7 +273,6 @@ public class PackageParameters extends Properties
* essentially restores all missing objects, but keeps existing ones intact.
*
* @param value boolean value (true = replace enabled, false = replace disabled)
* @return boolean result
*/
public void setKeepExistingModeEnabled(boolean value)
{
@@ -303,7 +299,6 @@ public class PackageParameters extends Properties
* Item Template
*
* @param value boolean value (true = template enabled, false = template disabled)
* @return boolean result
*/
public void setUseCollectionTemplate(boolean value)
{
@@ -336,7 +331,6 @@ public class PackageParameters extends Properties
* recursively performs the same action on all related objects.
*
* @param value boolean value (true = recursion enabled, false = recursion disabled)
* @return boolean result
*/
public void setRecursiveModeEnabled(boolean value)
{

6
dspace-api/src/main/java/org/dspace/core/Context.java
View File

@@ -561,10 +561,8 @@ public class Context
}
/**
* gets an array of all of the special groups that current user is a member
* of
*
* @return
* Get an array of all of the special groups that current user is a member
* of.
* @throws SQLException
*/
public Group[] getSpecialGroups() throws SQLException

1
dspace-api/src/main/java/org/dspace/core/I18nUtil.java
View File

@@ -95,7 +95,6 @@ public class I18nUtil
* return the default Locale for the repository.
*
* @param ep
* @return
*/
public static Locale getEPersonLocale(EPerson ep)
{

4
dspace-api/src/main/java/org/dspace/core/PluginInstantiationException.java
View File

@@ -34,7 +34,7 @@ public class PluginInstantiationException extends RuntimeException
/**
* @param msg Error message text.
* @cause cause other exception that this one is wrapping.
* @param cause other exception that this one is wrapping.
*/
public PluginInstantiationException(String msg, Throwable cause)
{
@@ -42,7 +42,7 @@ public class PluginInstantiationException extends RuntimeException
}
/**
* @cause cause other exception that this one is wrapping.
* @param cause other exception that this one is wrapping.
*/
public PluginInstantiationException(Throwable cause)
{

2
dspace-api/src/main/java/org/dspace/curate/Curator.java
View File

@@ -133,7 +133,7 @@ public class Curator
* Assigns invocation mode.
*
* @param mode one of INTERACTIVE, BATCH, ANY
* @return
* @return the Curator instance.
*/
public Curator setInvoked(Invoked mode)
{

20
dspace-api/src/main/java/org/dspace/discovery/SearchService.java
View File

@@ -31,13 +31,9 @@ public interface SearchService {
* repository)
*
* @param context
* DSpace Context object
* @param dso
* a DSpace Object to use as scope of the search (only results
* within this object)
* DSpace Context object.
* @param query
* the discovery query object
* @return
* the discovery query object.
* @throws SearchServiceException
*/
DiscoverResult search(Context context, DiscoverQuery query)
@@ -54,7 +50,6 @@ public interface SearchService {
* within this object)
* @param query
* the discovery query object
* @return
* @throws SearchServiceException
*/
DiscoverResult search(Context context, DSpaceObject dso, DiscoverQuery query)
@@ -63,14 +58,12 @@ public interface SearchService {
/**
*
* @param context
* DSpace Context object
* @param dso
* a DSpace Object to use as scope of the search (only results
* within this object)
* DSpace Context object.
* @param query
* the discovery query object.
* @param includeWithdrawn
* use <code>true</code> to include in the results also withdrawn
* items that match the query
* @return
* items that match the query.
* @throws SearchServiceException
*/
DiscoverResult search(Context context, DiscoverQuery query,
@@ -89,7 +82,6 @@ public interface SearchService {
* use <code>true</code> to include in the results also withdrawn
* items that match the query
*
* @return
* @throws SearchServiceException
*/
DiscoverResult search(Context context, DSpaceObject dso, DiscoverQuery query, boolean includeWithdrawn) throws SearchServiceException;

10
dspace-api/src/main/java/org/dspace/eperson/Group.java
View File

@@ -343,12 +343,11 @@ public class Group extends DSpaceObject
}
/**
* check to see if g is a direct group member.
* Check to see if g is a direct group member.
* If g is a subgroup via another group will be returned <code>false</code>
*
* @param g
* group to check
* @return
*/
public boolean isMember(Group g)
{
@@ -381,11 +380,10 @@ public class Group extends DSpaceObject
}
/**
* Get all of the groups that an eperson is a member of
* Get all of the groups that an eperson is a member of.
*
* @param c
* @param e
* @return
* @throws SQLException
*/
public static Group[] allMemberGroups(Context c, EPerson e)
@@ -1052,9 +1050,7 @@ public class Group extends DSpaceObject
}
/**
* Return Group members of a Group
*
* @return
* Return Group members of a Group.
*/
public Group[] getMemberGroups()
{

8
dspace-api/src/main/java/org/dspace/eperson/PasswordHash.java
View File

@@ -22,10 +22,10 @@ import org.slf4j.LoggerFactory;
/**
* For handling digested secrets (such as passwords).
* Use {@link PasswordHash(String, byte[], byte[])} to package and manipulate
* secrets that have already been hashed, and {@link PasswordHash(String)} for
* Use {@link #PasswordHash(String, byte[], byte[])} to package and manipulate
* secrets that have already been hashed, and {@link #PasswordHash(String)} for
* plaintext secrets. Compare a plaintext candidate to a hashed secret with
* {@link matches(String)}.
* {@link #matches(String)}.
*
* @author mwood
*/
@@ -78,7 +78,7 @@ public class PasswordHash
}
/**
* Convenience: like {@link PasswordHash(String, byte[], byte[])} but with
* Convenience: like {@link #PasswordHash(String, byte[], byte[])} but with
* hexadecimal-encoded {@code String}s.
* @param algorithm the digest algorithm used in producing {@code hash}.
* If empty, set to null. Other methods will treat this as unsalted MD5.

16
dspace-api/src/main/java/org/dspace/harvest/HarvestedCollection.java
View File

@@ -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.
@@ -215,7 +215,7 @@ public class HarvestedCollection
* Find all collections with the specified status flag
* @param c
* @param status see HarvestInstance.STATUS_...
* @return
* @return matching Collection IDs.
* @throws SQLException
*/
public static List<Integer> findByStatus(Context c, int status) throws SQLException {

24
dspace-api/src/main/java/org/dspace/identifier/IdentifierService.java
View File

@@ -23,25 +23,28 @@ import java.sql.SQLException;
public interface IdentifierService {
/**
* Get an identifier for a given object which is assignment-compatible
* with a given Identifier type.
*
* @param context
* @param dso
* @param identifier
* @return
* @param dso the object to be identified.
* @param identifier instance of an Identifier of the required type.
* @return the matching identifier, or the site identifier if the object
* is a Site, or null if no matching identifier is found.
*/
String lookup(Context context, DSpaceObject dso, Class<? extends Identifier> identifier);
/**
*
* This will resolve a DSpaceObject based on a provided Identifier. The Service will interrogate the providers in
* no particular order and return the first successful result discovered. If no resolution is successful,
* the method will return null if no object is found.
* This will resolve a DSpaceObject based on a provided Identifier.
* The Service will interrogate the providers in no particular order
* and return the first successful result discovered. If no resolution
* is successful, the method will return null if no object is found.
*
* TODO: Verify null is returned.
*
* @param context
* @param identifier
* @return
* @throws IdentifierNotFoundException
* @throws IdentifierNotResolvableException
*/
@@ -78,7 +81,6 @@ public interface IdentifierService {
*
* @param context
* @param dso
* @return
* @throws org.dspace.authorize.AuthorizeException
* @throws java.sql.SQLException
* @throws IdentifierException
@@ -87,14 +89,14 @@ public interface IdentifierService {
/**
*
* Used to Register a Specific Identifier (for example a Handle, hdl:1234.5/6) The provider is responsible for
* Detecting and Processing the appropriate identifier, all Providers are interrogated, multiple providers
* Used to Register a specific Identifier (for example a Handle, hdl:1234.5/6)
* The provider is responsible for detecting and processing the appropriate
* identifier. All Providers are interrogated. Multiple providers
* can process the same identifier.
*
* @param context
* @param dso
* @param identifier
* @return
* @throws org.dspace.authorize.AuthorizeException
* @throws java.sql.SQLException
* @throws IdentifierException

1
dspace-api/src/main/java/org/dspace/license/CCLookup.java
View File

@@ -153,7 +153,6 @@ public class CCLookup {
* @return A Collection of LicenseField objects.
*
* @see CCLicense
* @see LicenseField
*
*/
public Collection<CCLicenseField> getLicenseFields(String license) {

4
dspace-api/src/main/java/org/dspace/license/LicenseCleanup.java
View File

@@ -188,8 +188,8 @@ public class LicenseCleanup
/**
* Fast stream copy routine
*
* @param b
* @return
* @param b the Bitstream to be copied.
* @return copy of the content of {@code b}.
* @throws IOException
* @throws SQLException
* @throws AuthorizeException

17
dspace-api/src/main/java/org/dspace/sort/SortOption.java
View File

@@ -264,9 +264,7 @@ public class SortOption
}
/**
* Is this a date field
*
* @return
* Is this a date field?
*/
public boolean isDate()
{
@@ -279,9 +277,7 @@ public class SortOption
}
/**
* Is the default sort option
*
* @return
* Is the default sort option?
*/
public boolean isDefault()
{
@@ -293,8 +289,7 @@ public class SortOption
}
/**
* Return all the configured sort options
* @return
* Return all the configured sort options.
* @throws SortException
*/
public static Set<SortOption> getSortOptions() throws SortException
@@ -308,9 +303,8 @@ public class SortOption
}
/**
* Get the defined sort option by number (.1, .2, etc)
* Get the defined sort option by number (.1, .2, etc).
* @param number
* @return
* @throws SortException
*/
public static SortOption getSortOption(int number) throws SortException
@@ -327,8 +321,7 @@ public class SortOption
}
/**
* Get the default sort option - initially, just the first one defined
* @return
* Get the default sort option - initially, just the first one defined.
* @throws SortException
*/
public static SortOption getDefaultSortOption() throws SortException

2
dspace-api/src/main/java/org/dspace/statistics/DataTermsFacet.java
View File

@@ -31,7 +31,7 @@ public class DataTermsFacet {
*
* An example of the output could be of the format:
* [{"term":"247166","count":10},{"term":"247168","count":6}]
* @return
* @return JSON-formatted data.
*/
public String toJson() {
Gson gson = new Gson();

4
dspace-api/src/main/java/org/dspace/statistics/util/SpiderDetector.java
View File

@@ -77,9 +77,7 @@ public class SpiderDetector {
}
/**
* Get an immutable Set representing all the Spider Addresses here
*
* @return
* Get an immutable Set representing all the Spider Addresses here.
*/
public static Set<String> getSpiderIpAddresses() {

4
dspace-api/src/main/java/org/dspace/storage/bitstore/BitstreamStorageManager.java
View File

@@ -710,8 +710,8 @@ public class BitstreamStorageManager
/**
*
* @param context
* @param id of the bitstream to clone
* @return
* @param id of the bitstream to clone.
* @return id of the clone bitstream.
* @throws SQLException
*/
public static int clone(Context context, int id) throws SQLException

1
dspace-api/src/main/java/org/dspace/submit/step/DescribeStep.java
View File

@@ -995,7 +995,6 @@ public class DescribeStep extends AbstractProcessingStep
* Return the HTML / DRI field name for the given input.
*
* @param input
* @return
*/
public static String getFieldName(DCInput input)
{

2
dspace-api/src/main/java/org/dspace/submit/step/SkipInitialQuestionsStep.java
View File

@@ -30,7 +30,7 @@ import org.dspace.submit.AbstractProcessingStep;
* </p>
*
* @see org.dspace.submit.AbstractProcessingStep
* @see org.dspace.submit.step.InitialQuestionStep
* @see org.dspace.submit.step.InitialQuestionsStep
* @see org.dspace.submit.step.DescribeStep
*
* @author Andrea Bollini