leosimons 2003/02/11 08:19:27
Modified: src/java/org/apache/avalon/framework Version.java
src/java/org/apache/avalon/framework/configuration
AbstractConfiguration.java
DefaultConfiguration.java
DefaultConfigurationBuilder.java
src/java/org/apache/avalon/framework/logger
AvalonFormatter.java
src/java/org/apache/avalon/framework/parameters
Parameters.java
Log:
document additions from 4.0-->4.1.
Revision Changes Path
1.26 +6 -1 avalon/src/java/org/apache/avalon/framework/Version.java
Index: Version.java
===================================================================
RCS file: /home/cvs/avalon/src/java/org/apache/avalon/framework/Version.java,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- Version.java 11 Feb 2003 15:58:37 -0000 1.25
+++ Version.java 11 Feb 2003 16:19:27 -0000 1.26
@@ -105,6 +105,7 @@
* @return the new Version object
* @throws NumberFormatException if an error occurs
* @throws IllegalArgumentException if an error occurs
+ * @since 4.1
*/
public static Version getVersion( final String version )
throws NumberFormatException, IllegalArgumentException
@@ -157,6 +158,7 @@
* Retrieve major component of version.
*
* @return the major component of version
+ * @since 4.1
*/
public int getMajor()
{
@@ -167,6 +169,7 @@
* Retrieve minor component of version.
*
* @return the minor component of version
+ * @since 4.1
*/
public int getMinor()
{
@@ -177,6 +180,7 @@
* Retrieve micro component of version.
*
* @return the micro component of version.
+ * @since 4.1
*/
public int getMicro()
{
@@ -192,6 +196,7 @@
* @param other The other <code>Version</code> object to be compared with this
* for equality.
* @return <b>true</b> if this <code>Version</code> is compatible with the
specified one
+ * @since 4.1
*/
public boolean equals( final Version other )
{
1.28 +2 -1
avalon/src/java/org/apache/avalon/framework/configuration/AbstractConfiguration.java
Index: AbstractConfiguration.java
===================================================================
RCS file:
/home/cvs/avalon/src/java/org/apache/avalon/framework/configuration/AbstractConfiguration.java,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- AbstractConfiguration.java 11 Feb 2003 07:15:42 -0000 1.27
+++ AbstractConfiguration.java 11 Feb 2003 16:19:27 -0000 1.28
@@ -71,6 +71,7 @@
* @return A non-null String (defaults to "")
* @throws ConfigurationException if no prefix was defined (prefix is
* <code>null</code>.
+ * @since 4.1
*/
protected abstract String getPrefix() throws ConfigurationException;
1.32 +5 -2
avalon/src/java/org/apache/avalon/framework/configuration/DefaultConfiguration.java
Index: DefaultConfiguration.java
===================================================================
RCS file:
/home/cvs/avalon/src/java/org/apache/avalon/framework/configuration/DefaultConfiguration.java,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -r1.31 -r1.32
--- DefaultConfiguration.java 11 Feb 2003 15:58:39 -0000 1.31
+++ DefaultConfiguration.java 11 Feb 2003 16:19:27 -0000 1.32
@@ -110,7 +110,8 @@
* @param prefix A short string prefixed to element names, associating
* elements with a longer namespace string. Should not be null; use "" if no
* namespace.
- */
+ * @since 4.1
+ */
public DefaultConfiguration( final String name,
final String location,
final String ns,
@@ -135,6 +136,7 @@
* Returns the namespace of this configuration element
* @return a <code>String</code> value
* @throws ConfigurationException if an error occurs
+ * @since 4.1
*/
public String getNamespace() throws ConfigurationException
{
@@ -155,6 +157,7 @@
* Returns the prefix of the namespace
* @return a <code>String</code> value
* @throws ConfigurationException if prefix is not present (<code>null</code>).
+ * @since 4.1
*/
protected String getPrefix() throws ConfigurationException
{
1.26 +2 -1
avalon/src/java/org/apache/avalon/framework/configuration/DefaultConfigurationBuilder.java
Index: DefaultConfigurationBuilder.java
===================================================================
RCS file:
/home/cvs/avalon/src/java/org/apache/avalon/framework/configuration/DefaultConfigurationBuilder.java,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- DefaultConfigurationBuilder.java 11 Feb 2003 15:58:39 -0000 1.25
+++ DefaultConfigurationBuilder.java 11 Feb 2003 16:19:27 -0000 1.26
@@ -125,6 +125,7 @@
* @param enableNamespaces If <code>true</code>, a namespace-aware
* <code>SAXParser</code> is used. If <code>false</code>, the default JAXP
* <code>SAXParser</code> (without namespace support) is used.
+ * @since 4.1
*/
public DefaultConfigurationBuilder( final boolean enableNamespaces )
{
1.26 +3 -2
avalon/src/java/org/apache/avalon/framework/logger/AvalonFormatter.java
Index: AvalonFormatter.java
===================================================================
RCS file:
/home/cvs/avalon/src/java/org/apache/avalon/framework/logger/AvalonFormatter.java,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- AvalonFormatter.java 11 Feb 2003 15:58:40 -0000 1.25
+++ AvalonFormatter.java 11 Feb 2003 16:19:27 -0000 1.26
@@ -106,7 +106,8 @@
* and which which prints out exceptions to stackDepth of 8.
*
* @param pattern The pattern to use to format the log entries
- */
+ * @since 4.1
+ */
public AvalonFormatter( final String pattern )
{
this( pattern, DEFAULT_STACK_DEPTH, DEFAULT_PRINT_CASCADING );
1.37 +3 -1
avalon/src/java/org/apache/avalon/framework/parameters/Parameters.java
Index: Parameters.java
===================================================================
RCS file:
/home/cvs/avalon/src/java/org/apache/avalon/framework/parameters/Parameters.java,v
retrieving revision 1.36
retrieving revision 1.37
diff -u -r1.36 -r1.37
--- Parameters.java 11 Feb 2003 15:58:41 -0000 1.36
+++ Parameters.java 11 Feb 2003 16:19:27 -0000 1.37
@@ -141,6 +141,7 @@
/**
* Remove a parameter from the parameters object
* @param name a <code>String</code> value
+ * @since 4.1
*/
public void removeParameter( final String name )
{
@@ -608,6 +609,7 @@
* @param elementName the element name for the parameters
* @return This <code>Parameters</code> instance.
* @throws ConfigurationException if an error occurs
+ * @since 4.1
*/
public static Parameters fromConfiguration( final Configuration configuration,
final String elementName )
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
