bloritsch 2002/07/26 11:29:42
Modified: src/java/org/apache/avalon/framework/configuration
Configuration.java
src/proposal/avalon5/org/apache/framework/configuration
Configuration.java
Log:
Remove uncessary javadoc warnings
Revision Changes Path
1.20 +0 -80
jakarta-avalon/src/java/org/apache/avalon/framework/configuration/Configuration.java
Index: Configuration.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/configuration/Configuration.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- Configuration.java 26 Jun 2002 09:22:18 -0000 1.19
+++ Configuration.java 26 Jul 2002 18:29:42 -0000 1.20
@@ -137,8 +137,6 @@
* Return the name of the node.
*
* @return name of the <code>Configuration</code> node.
- * @post getName() != null
- *
*/
String getName();
@@ -192,9 +190,6 @@
*
* @param child The name of the child node.
* @return Configuration
- * @pre child != null
- * @post getConfiguration() != null
- *
*/
Configuration getChild( String child );
@@ -208,9 +203,6 @@
* <code>false</code>, <code>null</code> will be returned when the specified
* child doesn't exist.
* @return Configuration
- * @pre child != null
- * @post getConfiguration() != null
- *
*/
Configuration getChild( String child, boolean createNew );
@@ -230,9 +222,6 @@
*
* @param name The name of the children to get.
* @return The child nodes with name <code>name</code>
- * @pre name != null
- * @post getConfigurations() != null
- *
*/
Configuration[] getChildren( String name );
@@ -255,9 +244,6 @@
* @param paramName The name of the parameter you ask the value of.
* @return String value of attribute.
* @throws ConfigurationException If no attribute with that name exists.
- * @pre paramName != null
- * @post getAttribute != null
- *
*/
String getAttribute( String paramName ) throws ConfigurationException;
@@ -269,8 +255,6 @@
* @return int value of attribute
* @throws ConfigurationException If no parameter with that name exists.
* or if conversion to <code>int</code> fails.
- * @pre paramName != null
- * @post getAttributeAsInteger() != null
*
*/
int getAttributeAsInteger( String paramName ) throws ConfigurationException;
@@ -283,9 +267,6 @@
* @return long value of attribute
* @throws ConfigurationException If no parameter with that name exists.
* or if conversion to <code>long</code>
fails.
- * @pre paramName != null
- * @post getAttributeAsLong() != null
- *
*/
long getAttributeAsLong( String name ) throws ConfigurationException;
@@ -297,9 +278,6 @@
* @return float value of attribute
* @throws ConfigurationException If no parameter with that name exists.
* or if conversion to <code>float</code>
fails.
- * @pre paramName != null
- * @post getAttributeAsFloat() != null
- *
*/
float getAttributeAsFloat( String paramName ) throws ConfigurationException;
@@ -311,9 +289,6 @@
* @return boolean value of attribute
* @throws ConfigurationException If no parameter with that name exists.
* or if conversion to <code>boolean</code>
fails.
- * @pre paramName != null
- * @post getAttributeAsBoolean() != null
- *
*/
boolean getAttributeAsBoolean( String paramName ) throws ConfigurationException;
@@ -322,8 +297,6 @@
*
* @return the value of the node.
* @throws ConfigurationException if an error occurs
- * @post getValue() != null
- *
*/
String getValue() throws ConfigurationException;
@@ -333,8 +306,6 @@
* @return the value of the node.
*
* @throws ConfigurationException If conversion to <code>int</code> fails.
- * @post getValueAsInteger() != null
- *
*/
int getValueAsInteger() throws ConfigurationException;
@@ -343,8 +314,6 @@
*
* @return the value of the node.
* @throws ConfigurationException If conversion to <code>float</code> fails.
- * @post getValueAsFloat() != null
- *
*/
float getValueAsFloat() throws ConfigurationException;
@@ -353,8 +322,6 @@
*
* @return the value of the node.
* @throws ConfigurationException If conversion to <code>boolean</code> fails.
- * @post getValueAsBoolean() != null
- *
*/
boolean getValueAsBoolean() throws ConfigurationException;
@@ -363,8 +330,6 @@
*
* @return the value of the node.
* @throws ConfigurationException If conversion to <code>long</code> fails.
- * @post getValueAsLong() != null
- *
*/
long getValueAsLong() throws ConfigurationException;
@@ -376,9 +341,6 @@
* @param defaultValue The default value desired.
* @return String value of the <code>Configuration</code>, or default
* if none specified.
- * @pre defaultValue != null
- * @post getValue(defaultValue) != null
- *
*/
String getValue( String defaultValue );
@@ -390,9 +352,6 @@
* @param defaultValue The default value desired.
* @return int value of the <code>Configuration</code>, or default
* if none specified.
- * @pre defaultValue != null
- * @post getValueAsInteger(defaultValue) != null
- *
*/
int getValueAsInteger( int defaultValue );
@@ -404,9 +363,6 @@
* @param defaultValue The default value desired.
* @return long value of the <code>Configuration</code>, or default
* if none specified.
- * @pre defaultValue != null
- * @post getValueAsLong(defaultValue) != null
- *
*/
long getValueAsLong( long defaultValue );
@@ -418,9 +374,6 @@
* @param defaultValue The default value desired.
* @return float value of the <code>Configuration</code>, or default
* if none specified.
- * @pre defaultValue != null
- * @post getValueAsFloat(defaultValue) != null
- *
*/
float getValueAsFloat( float defaultValue );
@@ -432,9 +385,6 @@
* @param defaultValue The default value desired.
* @return boolean value of the <code>Configuration</code>, or default
* if none specified.
- * @pre defaultValue != null
- * @post getValueAsBoolean(defaultValue) != null
- *
*/
boolean getValueAsBoolean( boolean defaultValue );
@@ -448,12 +398,6 @@
* @return String value of attribute. It will return the default
* value if the named attribute does not exist, or if
* the value is not set.
- * @pre name != null
- * @pre defaultValue != null
- * @pre name != null
- * @pre defaultValue != null
- * @post getAttribute(name, defaultValue) != null
- *
*/
String getAttribute( String name, String defaultValue );
@@ -467,12 +411,6 @@
* @return int value of attribute. It will return the default
* value if the named attribute does not exist, or if
* the value is not set.
- * @pre name != null
- * @pre defaultValue != null
- * @pre name != null
- * @pre defaultValue != null
- * @post getAttributeAsInteger(name, defaultValue) != null
- *
*/
int getAttributeAsInteger( String name, int defaultValue );
@@ -486,12 +424,6 @@
* @return long value of attribute. It will return the default
* value if the named attribute does not exist, or if
* the value is not set.
- * @pre name != null
- * @pre defaultValue != null
- * @pre name != null
- * @pre defaultValue != null
- * @post getAttributeAsLong(name, defaultValue) != null
- *
*/
long getAttributeAsLong( String name, long defaultValue );
@@ -505,12 +437,6 @@
* @return float value of attribute. It will return the default
* value if the named attribute does not exist, or if
* the value is not set.
- * @pre name != null
- * @pre defaultValue != null
- * @pre name != null
- * @pre defaultValue != null
- * @post getAttributeAsFloat(name, defaultValue) != null
- *
*/
float getAttributeAsFloat( String name, float defaultValue );
@@ -524,12 +450,6 @@
* @return boolean value of attribute. It will return the default
* value if the named attribute does not exist, or if
* the value is not set.
- * @pre name != null
- * @pre defaultValue != null
- * @pre name != null
- * @pre defaultValue != null
- * @post getAttributeAsBoolean(name, defaultValue) != null
- *
*/
boolean getAttributeAsBoolean( String name, boolean defaultValue );
}
1.3 +0 -79
jakarta-avalon/src/proposal/avalon5/org/apache/framework/configuration/Configuration.java
Index: Configuration.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon/src/proposal/avalon5/org/apache/framework/configuration/Configuration.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Configuration.java 25 Jun 2002 13:30:35 -0000 1.2
+++ Configuration.java 26 Jul 2002 18:29:42 -0000 1.3
@@ -180,8 +180,6 @@
* Return the name of the node.
*
* @return name of the <code>Configuration</code> node.
- * @post getName() != null
- *
*/
String getName();
@@ -235,9 +233,6 @@
*
* @param child The name of the child node.
* @return Configuration
- * @pre child != null
- * @post getConfiguration() != null
- *
*/
Configuration getChild( String child );
@@ -251,9 +246,6 @@
* <code>false</code>, <code>null</code> will be returned when the specified
* child doesn't exist.
* @return Configuration
- * @pre child != null
- * @post getConfiguration() != null
- *
*/
Configuration getChild( String child, boolean createNew );
@@ -273,9 +265,6 @@
*
* @param name The name of the children to get.
* @return The child nodes with name <code>name</code>
- * @pre name != null
- * @post getConfigurations() != null
- *
*/
Configuration[] getChildren( String name );
@@ -298,9 +287,6 @@
* @param paramName The name of the parameter you ask the value of.
* @return String value of attribute.
* @exception ConfigurationException If no attribute with that name exists.
- * @pre paramName != null
- * @post getAttribute != null
- *
*/
String getAttribute( String paramName ) throws ConfigurationException;
@@ -312,9 +298,6 @@
* @return int value of attribute
* @exception ConfigurationException If no parameter with that name exists.
* or if conversion to <code>int</code> fails.
- * @pre paramName != null
- * @post getAttributeAsInteger() != null
- *
*/
int getAttributeAsInteger( String paramName ) throws ConfigurationException;
@@ -326,9 +309,6 @@
* @return long value of attribute
* @exception ConfigurationException If no parameter with that name exists.
* or if conversion to <code>long</code>
fails.
- * @pre paramName != null
- * @post getAttributeAsLong() != null
- *
*/
long getAttributeAsLong( String name ) throws ConfigurationException;
@@ -340,9 +320,6 @@
* @return float value of attribute
* @exception ConfigurationException If no parameter with that name exists.
* or if conversion to <code>float</code>
fails.
- * @pre paramName != null
- * @post getAttributeAsFloat() != null
- *
*/
float getAttributeAsFloat( String paramName ) throws ConfigurationException;
@@ -354,9 +331,6 @@
* @return boolean value of attribute
* @exception ConfigurationException If no parameter with that name exists.
* or if conversion to <code>boolean</code>
fails.
- * @pre paramName != null
- * @post getAttributeAsBoolean() != null
- *
*/
boolean getAttributeAsBoolean( String paramName ) throws ConfigurationException;
@@ -376,8 +350,6 @@
* @return the value of the node.
*
* @exception ConfigurationException If conversion to <code>int</code> fails.
- * @post getValueAsInteger() != null
- *
*/
int getValueAsInteger() throws ConfigurationException;
@@ -386,8 +358,6 @@
*
* @return the value of the node.
* @exception ConfigurationException If conversion to <code>float</code> fails.
- * @post getValueAsFloat() != null
- *
*/
float getValueAsFloat() throws ConfigurationException;
@@ -396,8 +366,6 @@
*
* @return the value of the node.
* @exception ConfigurationException If conversion to <code>boolean</code>
fails.
- * @post getValueAsBoolean() != null
- *
*/
boolean getValueAsBoolean() throws ConfigurationException;
@@ -406,8 +374,6 @@
*
* @return the value of the node.
* @exception ConfigurationException If conversion to <code>long</code> fails.
- * @post getValueAsLong() != null
- *
*/
long getValueAsLong() throws ConfigurationException;
@@ -419,9 +385,6 @@
* @param defaultValue The default value desired.
* @return String value of the <code>Configuration</code>, or default
* if none specified.
- * @pre defaultValue != null
- * @post getValue(defaultValue) != null
- *
*/
String getValue( String defaultValue );
@@ -433,9 +396,6 @@
* @param defaultValue The default value desired.
* @return int value of the <code>Configuration</code>, or default
* if none specified.
- * @pre defaultValue != null
- * @post getValueAsInteger(defaultValue) != null
- *
*/
int getValueAsInteger( int defaultValue );
@@ -447,9 +407,6 @@
* @param defaultValue The default value desired.
* @return long value of the <code>Configuration</code>, or default
* if none specified.
- * @pre defaultValue != null
- * @post getValueAsLong(defaultValue) != null
- *
*/
long getValueAsLong( long defaultValue );
@@ -461,9 +418,6 @@
* @param defaultValue The default value desired.
* @return float value of the <code>Configuration</code>, or default
* if none specified.
- * @pre defaultValue != null
- * @post getValueAsFloat(defaultValue) != null
- *
*/
float getValueAsFloat( float defaultValue );
@@ -475,9 +429,6 @@
* @param defaultValue The default value desired.
* @return boolean value of the <code>Configuration</code>, or default
* if none specified.
- * @pre defaultValue != null
- * @post getValueAsBoolean(defaultValue) != null
- *
*/
boolean getValueAsBoolean( boolean defaultValue );
@@ -491,12 +442,6 @@
* @return String value of attribute. It will return the default
* value if the named attribute does not exist, or if
* the value is not set.
- * @pre name != null
- * @pre defaultValue != null
- * @pre name != null
- * @pre defaultValue != null
- * @post getAttribute(name, defaultValue) != null
- *
*/
String getAttribute( String name, String defaultValue );
@@ -510,12 +455,6 @@
* @return int value of attribute. It will return the default
* value if the named attribute does not exist, or if
* the value is not set.
- * @pre name != null
- * @pre defaultValue != null
- * @pre name != null
- * @pre defaultValue != null
- * @post getAttributeAsInteger(name, defaultValue) != null
- *
*/
int getAttributeAsInteger( String name, int defaultValue );
@@ -529,12 +468,6 @@
* @return long value of attribute. It will return the default
* value if the named attribute does not exist, or if
* the value is not set.
- * @pre name != null
- * @pre defaultValue != null
- * @pre name != null
- * @pre defaultValue != null
- * @post getAttributeAsLong(name, defaultValue) != null
- *
*/
long getAttributeAsLong( String name, long defaultValue );
@@ -548,12 +481,6 @@
* @return float value of attribute. It will return the default
* value if the named attribute does not exist, or if
* the value is not set.
- * @pre name != null
- * @pre defaultValue != null
- * @pre name != null
- * @pre defaultValue != null
- * @post getAttributeAsFloat(name, defaultValue) != null
- *
*/
float getAttributeAsFloat( String name, float defaultValue );
@@ -567,12 +494,6 @@
* @return boolean value of attribute. It will return the default
* value if the named attribute does not exist, or if
* the value is not set.
- * @pre name != null
- * @pre defaultValue != null
- * @pre name != null
- * @pre defaultValue != null
- * @post getAttributeAsBoolean(name, defaultValue) != null
- *
*/
boolean getAttributeAsBoolean( String name, boolean defaultValue );
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
