Author: dennisl
Date: Wed Jan 5 23:14:08 2011
New Revision: 1055685
URL: http://svn.apache.org/viewvc?rev=1055685&view=rev
Log:
Tidy up the Javadoc.
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/CompositeMap.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/InterpolatorFilterReaderLineEnding.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilterRequest.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MultiDelimiterInterpolatorFilterReaderLineEnding.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java?rev=1055685&r1=1055684&r2=1055685&view=diff
==============================================================================
---
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java
(original)
+++
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java
Wed Jan 5 23:14:08 2011
@@ -44,14 +44,18 @@ public class AbstractMavenFilteringReque
private MavenSession mavenSession;
/**
- * List of String considered as expressions which contains values in the
project/pom : pom project
- * default value will be pom and project.
+ * List of Strings considered as expressions which contains values in the
project/pom:
+ * pom project
+ * Default value will be pom and project.
+ *
* @since 1.0-beta-2
*/
private List projectStartExpressions = new ArrayList();
/**
- * String which will escape interpolation mechanism : foo \${foo.bar} ->
foo ${foo.bar}
+ * String which will escape interpolation mechanism:
+ * foo \${foo.bar} -> foo ${foo.bar}
+ *
* @since 1.0-beta-2
*/
private String escapeString;
@@ -68,7 +72,7 @@ public class AbstractMavenFilteringReque
/**
* Set of expression delimiter specifications to use during filtering.
Delimiter specifications are
- * given in the form 'BEGIN*END' or, for symmetical delimiters, simply
'TOKEN'. The default
+ * given in the form 'BEGIN*END' or, for symmetrical delimiters, simply
'TOKEN'. The default
* values are '${*}' and '@'.
*
* @since 1.0-beta-3
@@ -76,7 +80,8 @@ public class AbstractMavenFilteringReque
private LinkedHashSet delimiters = new LinkedHashSet();
/**
- * not stop trying filtering tokens when reaching EOL
+ * Do not stop trying to filter tokens when reaching EOL.
+ *
* @since 1.0-beta-5
*/
private boolean supportMultiLineFiltering;
@@ -87,7 +92,7 @@ public class AbstractMavenFilteringReque
}
protected AbstractMavenFilteringRequest( MavenProject mavenProject, List
filters,
- String encoding, MavenSession
mavenSession )
+ String encoding, MavenSession
mavenSession )
{
initDefaults();
this.mavenProject = mavenProject;
@@ -214,7 +219,6 @@ public class AbstractMavenFilteringReque
}
/**
- * @return
* @since 1.0-beta-2
*/
public String getEscapeString()
@@ -232,7 +236,6 @@ public class AbstractMavenFilteringReque
}
/**
- * @return
* @since 1.0-beta-2
*/
public List getProjectStartExpressions()
@@ -251,7 +254,8 @@ public class AbstractMavenFilteringReque
/**
* See {...@link AbstractMavenFilteringRequest#delimiters} for more
information and default values.
- * @return Not allowed to be null or empty.
+ *
+ * @return Not allowed to be <code>null</code> or empty.
* @since 1.0-beta-3
*/
public LinkedHashSet getDelimiters()
@@ -261,10 +265,10 @@ public class AbstractMavenFilteringReque
/**
* Set the delimiter specifications to use during filtering.
Specifications should be of the form:
- * 'BEGIN*END' for asymmetical delimiters, or 'TOKEN' for symmetical
delimiters. See
+ * 'BEGIN*END' for asymmetrical delimiters, or 'TOKEN' for symmetrical
delimiters. See
* {...@link AbstractMavenFilteringRequest#delimiters} for more
information and default values.
*
- * @param delimiters If null, reset delimiters to '${*}' only. Otherwise,
use the provided parameter value.
+ * @param delimiters If <code>null</code>, reset delimiters to '${*}'
only. Otherwise, use the provided parameter value.
* @since 1.0-beta-3
*/
public void setDelimiters( LinkedHashSet delimiters )
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/CompositeMap.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/CompositeMap.java?rev=1055685&r1=1055684&r2=1055685&view=diff
==============================================================================
---
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/CompositeMap.java
(original)
+++
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/CompositeMap.java
Wed Jan 5 23:14:08 2011
@@ -27,8 +27,9 @@ import java.util.Map;
import java.util.Set;
/**
- * A Map composed with some others (optional adding SystemProperties and
envvar)
- * The get Method look in the Map list to return the corresponding value
+ * A Map composed with some others (optional adding SystemProperties and
envvar).
+ * The get method look in the Map list to return the corresponding value.
+ *
* @author <a href="mailto:[email protected]";>olamy</a>
* @version $Id$
*/
@@ -50,9 +51,9 @@ public class CompositeMap
}
/**
- * @param maps an orderer {...@link List} of {...@link Map}
+ * @param maps an ordered {...@link List} of {...@link Map}
* @param useSystemProperties using or not the System Properties
- * @param systemPropertiesFirst if with get( key ) the sysProps must wins
(the internal ordered {...@link List}
+ * @param systemPropertiesFirst if with get( key ) the sysProps must win
(the internal ordered {...@link List}
* will have in first the System Properties)
*/
public CompositeMap( List /*Map*/maps, boolean useSystemProperties,
boolean systemPropertiesFirst )
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/InterpolatorFilterReaderLineEnding.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/InterpolatorFilterReaderLineEnding.java?rev=1055685&r1=1055684&r2=1055685&view=diff
==============================================================================
---
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/InterpolatorFilterReaderLineEnding.java
(original)
+++
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/InterpolatorFilterReaderLineEnding.java
Wed Jan 5 23:14:08 2011
@@ -84,6 +84,7 @@ public class InterpolatorFilterReaderLin
* @param interpolator interpolator instance to use
* @param beginToken start token to use
* @param endToken end token to use
+ * @param supportMultiLineFiltering If multi line filtering is allowed
*/
public InterpolatorFilterReaderLineEnding( Reader in, Interpolator
interpolator, String beginToken, String endToken, boolean
supportMultiLineFiltering )
{
@@ -96,6 +97,7 @@ public class InterpolatorFilterReaderLin
* @param beginToken start token to use
* @param endToken end token to use
* @param ri The {...@link RecursionInterceptor} to use to prevent
recursive expressions.
+ * @param supportMultiLineFiltering If multi line filtering is allowed
*/
private InterpolatorFilterReaderLineEnding( Reader in, Interpolator
interpolator, String beginToken, String endToken, RecursionInterceptor ri,
boolean supportMultiLineFiltering )
{
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java?rev=1055685&r1=1055684&r2=1055685&view=diff
==============================================================================
---
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
(original)
+++
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
Wed Jan 5 23:14:08 2011
@@ -33,9 +33,9 @@ public interface MavenFileFilter
{
/**
- * Will copy a file with some filtering using defaultFilterWrappers
+ * Will copy a file with some filtering using defaultFilterWrappers.
+ *
* @see #getDefaultFilterWrappers(MavenProject, List, boolean,
MavenSession)
- *
* @param from file to copy/filter
* @param to destination file
* @param filtering enable or not filering
@@ -44,13 +44,13 @@ public interface MavenFileFilter
* @throws MavenFilteringException
*/
void copyFile( File from, final File to, boolean filtering, MavenProject
mavenProject, List filters,
- boolean escapedBackslashesInFilePath, String
encoding, MavenSession mavenSession )
+ boolean escapedBackslashesInFilePath, String encoding,
MavenSession mavenSession )
throws MavenFilteringException;
/**
- * @since 1.0-beta-3
* @param mavenFileFilterRequest
* @throws MavenFilteringException
+ * @since 1.0-beta-3
*/
void copyFile( MavenFileFilterRequest mavenFileFilterRequest )
throws MavenFilteringException;
@@ -73,15 +73,14 @@ public interface MavenFileFilter
* @param filterWrappers
* @param encoding
* @param overwrite
- * @since 1.0-beta-2
* @throws MavenFilteringException
+ * @since 1.0-beta-2
*/
void copyFile( File from, final File to, boolean filtering, List
filterWrappers, String encoding, boolean overwrite )
throws MavenFilteringException;
/**
- *
- * Will return the default FileUtils.FilterWrappers
+ * Will return the default FileUtils.FilterWrappers.
*
* <ul>
* <li>interpolate with token ${} and values from sysProps,
project.properties, filters and project filters.</li>
@@ -89,38 +88,37 @@ public interface MavenFileFilter
* <li>interpolate with token ${} and values from mavenProject
interpolation.</li>
* <li>interpolation with token @ @ and values from mavenProject
interpolation</li>
* </ul>
- * <b>this method si now deprecated and no escape mechanism will be use</b>
- * @deprecated use {...@link #getDefaultFilterWrappers(MavenProject, List,
boolean, MavenSession, MavenResourcesExecution)}
+ * <b>This method is now deprecated and no escape mechanism will be
used.</b>
+ *
* @param mavenProject
* @param filters {...@link List} of properties file
- *
- * @return {...@link List} of FileUtils.FilterWrapper
- *
+ * @return {...@link List} of FileUtils.FilterWrapper
+ * @deprecated use {...@link #getDefaultFilterWrappers(MavenProject, List,
boolean, MavenSession, MavenResourcesExecution)}
*/
List getDefaultFilterWrappers( MavenProject mavenProject, List filters,
boolean escapedBackslashesInFilePath,
MavenSession mavenSession )
throws MavenFilteringException;
/**
- * @since 1.0-beta-2
* @param mavenProject
* @param filters
* @param escapedBackslashesInFilePath
* @param mavenSession
* @param mavenResourcesExecution
- * @return {...@link List} of FileUtils.FilterWrapper
+ * @return {...@link List} of FileUtils.FilterWrapper
* @throws MavenFilteringException
+ * @since 1.0-beta-2
*/
List getDefaultFilterWrappers( MavenProject mavenProject, List filters,
boolean escapedBackslashesInFilePath,
MavenSession mavenSession,
MavenResourcesExecution mavenResourcesExecution )
throws MavenFilteringException;
/**
- * @since 1.0-beta-3
* @param request
- * @return {...@link List} of FileUtils.FilterWrapper
+ * @return {...@link List} of FileUtils.FilterWrapper
* @throws MavenFilteringException
- */
+ * @since 1.0-beta-3
+ */
List getDefaultFilterWrappers( AbstractMavenFilteringRequest request )
throws MavenFilteringException;
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilterRequest.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilterRequest.java?rev=1055685&r1=1055684&r2=1055685&view=diff
==============================================================================
---
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilterRequest.java
(original)
+++
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilterRequest.java
Wed Jan 5 23:14:08 2011
@@ -28,7 +28,6 @@ import org.apache.maven.project.MavenPro
/**
* @author <a href="mailto:ol...@apache";>olamy</a>
- *
* @since 1.0-beta-3
*/
public class MavenFileFilterRequest
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java?rev=1055685&r1=1055684&r2=1055685&view=diff
==============================================================================
---
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java
(original)
+++
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java
Wed Jan 5 23:14:08 2011
@@ -34,7 +34,8 @@ import org.codehaus.plexus.util.FileUtil
import org.codehaus.plexus.util.FileUtils.FilterWrapper;
/**
- * A bean to configure a resources filtering execution
+ * A bean to configure a resources filtering execution.
+ *
* @author <a href="mailto:[email protected]";>olamy</a>
* @version $Id$
*/
@@ -58,19 +59,22 @@ public class MavenResourcesExecution
/**
* Overwrite existing files even if the destination files are newer.
- * <b>false by default</b>
+ * <code>false</code> by default.
+ *
* @since 1.0-beta-2
*/
private boolean overwrite = false;
/**
* Copy any empty directories included in the Resources.
+ *
* @since 1.0-beta-2
*/
private boolean includeEmptyDirs = false;
/**
- * not stop trying filtering tokens when reaching EOL
+ * Do not stop trying to filter tokens when reaching EOL.
+ *
* @since 1.0-beta-5
*/
private boolean supportMultiLineFiltering;
@@ -81,7 +85,8 @@ public class MavenResourcesExecution
}
/**
- * <b>As we use a maven project useDefaultFilterWrappers will set to
true</b>
+ * As we use a Maven project <code>useDefaultFilterWrappers</code> will be
set to <code>true</code>.
+ *
* @param resources
* @param outputDirectory
* @param mavenProject
@@ -142,7 +147,7 @@ public class MavenResourcesExecution
}
/**
- * @return List of {...@link String} file extensions to not filtering
+ * @return List of {...@link String} file extensions to not filter
*/
public List getNonFilteredFileExtensions()
{
@@ -150,7 +155,7 @@ public class MavenResourcesExecution
}
/**
- * @param nonFilteredFileExtensions List of {...@link String} file
extensions to not filtering
+ * @param nonFilteredFileExtensions List of {...@link String} file
extensions to not filter
*/
public void setNonFilteredFileExtensions( List nonFilteredFileExtensions )
{
@@ -184,9 +189,10 @@ public class MavenResourcesExecution
/**
* Helper to add {...@link FileUtils.FilterWrapper}, will {...@link
RegexBasedInterpolator} with default regex Exp ${ }
- * and InterpolatorFilterReaderLineEnding with defaultTokens ${ }
+ * and InterpolatorFilterReaderLineEnding with defaultTokens ${ }.
+ *
* @param valueSource
- * @deprecated this doesn't support escaping use {...@link
#addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
+ * @deprecated This doesn't support escaping use {...@link
#addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
*/
public void addFilerWrapper( final ValueSource valueSource )
{
@@ -209,7 +215,7 @@ public class MavenResourcesExecution
* @param endRegExp
* @param startToken
* @param endToken
- * @deprecated this doesn't support escaping use {...@link
#addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
+ * @deprecated This doesn't support escaping use {...@link
#addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
*/
public void addFilerWrapper( final ValueSource valueSource, final String
startRegExp, final String endRegExp,
final String startToken, final String
endToken )
@@ -231,7 +237,7 @@ public class MavenResourcesExecution
* @param endExp endToken }
* @since 1.0-beta-2
* @param escapeString
- * @deprecated this doesn't support escaping use {...@link
#addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
+ * @deprecated This doesn't support escaping use {...@link
#addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
*/
public void addFilerWrapperWithEscaping( final ValueSource valueSource,
final String startExp, final String endExp,
final String escapeString )
@@ -259,7 +265,7 @@ public class MavenResourcesExecution
* @param endExp endToken }
* @since 1.0-beta-5
* @param escapeString
- * @param supportMultiLineFiltering do we support or to use filtering on
multi lines start and endotken on multi lines)
+ * @param supportMultiLineFiltering do we support or use filtering on
multi lines with start and endtoken on multi lines)
*/
public void addFilerWrapperWithEscaping( final ValueSource valueSource,
final String startExp, final String endExp,
final String escapeString, final
boolean supportMultiLineFiltering )
@@ -304,7 +310,7 @@ public class MavenResourcesExecution
/**
* Overwrite existing files even if the destination files are newer.
- * @return
+ *
* @since 1.0-beta-2
*/
public boolean isOverwrite()
@@ -314,6 +320,7 @@ public class MavenResourcesExecution
/**
* Overwrite existing files even if the destination files are newer.
+ *
* @param overwrite
* @since 1.0-beta-2
*/
@@ -324,7 +331,7 @@ public class MavenResourcesExecution
/**
* Copy any empty directories included in the Resources.
- * @return
+ *
* @since 1.0-beta-2
*/
public boolean isIncludeEmptyDirs()
@@ -334,6 +341,7 @@ public class MavenResourcesExecution
/**
* Copy any empty directories included in the Resources.
+ *
* @param includeEmptyDirs
* @since 1.0-beta-2
*/
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java?rev=1055685&r1=1055684&r2=1055685&view=diff
==============================================================================
---
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java
(original)
+++
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java
Wed Jan 5 23:14:08 2011
@@ -40,8 +40,8 @@ public interface MavenResourcesFiltering
* @param fileFilters {...@link List} of String which are path to a
Property file
* @param nonFilteredFileExtensions {...@link List} of String for non
filtered file extensions
* @param mavenSession Can include executionProperties that will be used
for filtering
- * @deprecated use {...@link #filterResources(MavenResourcesExecution)}
* @throws MavenFilteringException
+ * @deprecated use {...@link #filterResources(MavenResourcesExecution)}
*/
void filterResources( List resources, File outputDirectory, MavenProject
mavenProject, String encoding,
List fileFilters, List nonFilteredFileExtensions,
MavenSession mavenSession )
@@ -54,8 +54,8 @@ public interface MavenResourcesFiltering
* @param filterWrappers {...@link List} of FileUtils.FilterWrapper
* @param resourcesBaseDirectory baseDirectory of resources
* @param nonFilteredFileExtensions {...@link List} of String for non
filtered file extensions
- * @deprecated use {...@link #filterResources(MavenResourcesExecution)}
* @throws MavenFilteringException
+ * @deprecated use {...@link #filterResources(MavenResourcesExecution)}
*/
void filterResources( List resources, File outputDirectory, String
encoding, List filterWrappers,
File resourcesBaseDirectory, List
nonFilteredFileExtensions )
@@ -70,7 +70,7 @@ public interface MavenResourcesFiltering
/**
* @param fileName the file name
* @param userNonFilteredFileExtensions an extra list of file extensions
- * @return true if filtering can be apply to the file (means
extensions.lowerCase is in the
+ * @return true if filtering can be applied to the file (means
extensions.lowerCase is in the
* default List or in the user defined extension List)
*/
boolean filteredFileExtension( String fileName, List
userNonFilteredFileExtensions );
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MultiDelimiterInterpolatorFilterReaderLineEnding.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MultiDelimiterInterpolatorFilterReaderLineEnding.java?rev=1055685&r1=1055684&r2=1055685&view=diff
==============================================================================
---
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MultiDelimiterInterpolatorFilterReaderLineEnding.java
(original)
+++
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MultiDelimiterInterpolatorFilterReaderLineEnding.java
Wed Jan 5 23:14:08 2011
@@ -69,9 +69,11 @@ public class MultiDelimiterInterpolatorF
private boolean supportMultiLineFiltering;
/**
- * this constructor use default begin token ${ and default end token }
+ * This constructor uses default begin token ${ and default end token }.
+ *
* @param in reader to use
* @param interpolator interpolator instance to use
+ * @param supportMultiLineFiltering If multi line filtering is allowed
*/
public MultiDelimiterInterpolatorFilterReaderLineEnding( Reader in,
Interpolator interpolator, boolean supportMultiLineFiltering )
{
@@ -81,10 +83,8 @@ public class MultiDelimiterInterpolatorF
/**
* @param in reader to use
* @param interpolator interpolator instance to use
- * @param beginToken start token to use
- * @param endToken end token to use
* @param ri The {...@link RecursionInterceptor} to use to prevent
recursive expressions.
- * @since 1.12
+ * @param supportMultiLineFiltering If multi line filtering is allowed
*/
public MultiDelimiterInterpolatorFilterReaderLineEnding( Reader in,
Interpolator interpolator, RecursionInterceptor ri, boolean
supportMultiLineFiltering )
{
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java?rev=1055685&r1=1055684&r2=1055685&view=diff
==============================================================================
---
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java
(original)
+++
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertyUtils.java
Wed Jan 5 23:14:08 2011
@@ -38,7 +38,7 @@ import java.util.Properties;
public final class PropertyUtils
{
/**
- * private empty constructor to prevent instantiation
+ * Private empty constructor to prevent instantiation.
*/
private PropertyUtils()
{
@@ -53,7 +53,7 @@ public final class PropertyUtils
* </p>
*
* @param propFile The property file to load.
- * @param baseProps Properties containing the initial values to subsitute
into the properties file.
+ * @param baseProps Properties containing the initial values to substitute
into the properties file.
* @return Properties object containing the properties in the file with
their values fully resolved.
* @throws IOException if profile does not exist, or cannot be read.
*/
@@ -81,7 +81,7 @@ public final class PropertyUtils
combinedProps.putAll( fileProps );
// The algorithm iterates only over the fileProps which is all that is
required to resolve
- // the properties defined within the file. This is slighlty different
to current, however
+ // the properties defined within the file. This is slightly different
to current, however
// I suspect that this was the actual original intent.
//
// The difference is that #loadPropertyFile(File, boolean, boolean)
also resolves System properties
@@ -103,8 +103,8 @@ public final class PropertyUtils
* Reads a property file, resolving all internal variables.
*
* @param propfile The property file to load
- * @param fail wheter to throw an exception when the file cannot be loaded
or to return null
- * @param useSystemProps wheter to incorporate System.getProperties
settings into the returned Properties object.
+ * @param fail whether to throw an exception when the file cannot be
loaded or to return null
+ * @param useSystemProps whether to incorporate System.getProperties
settings into the returned Properties object.
* @return the loaded and fully resolved Properties object
* @throws IOException if profile does not exist, or cannot be read.
*/
@@ -150,6 +150,7 @@ public final class PropertyUtils
* the value of a property contains a key), and will
* not loop endlessly on a pair like
* test = ${test}.
+ *
* @param k
* @param p
* @return The filtered property value.
