Author: ivaynberg
Date: Tue Sep 18 19:02:25 2007
New Revision: 577130
URL: http://svn.apache.org/viewvc?rev=577130&view=rev
Log:
WICKET-986: Wicket Javadoc Standardization: org.apache.wicket.util.value
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/AttributeMap.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/CopyOnWriteValueMap.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/Count.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/IValueMap.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/IntValue.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/LongValue.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/ValueMap.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/package.html
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/AttributeMap.java
URL:
http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/AttributeMap.java?rev=577130&r1=577129&r2=577130&view=diff
==============================================================================
---
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/AttributeMap.java
(original)
+++
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/AttributeMap.java
Tue Sep 18 19:02:25 2007
@@ -19,16 +19,17 @@
import java.util.Map;
/**
- * ValueMap for attributes.
+ * <code>ValueMap</code> for attributes.
*
* @author Eelco Hillenius
+ * @since 1.2.6
*/
public final class AttributeMap extends ValueMap
{
private static final long serialVersionUID = 1L;
/**
- * Constructs an empty map.
+ * Constructs an empty <code>AttributeMap</code>.
*/
public AttributeMap()
{
@@ -39,7 +40,7 @@
* Copy constructor.
*
* @param map
- * Map to be copied
+ * a <code>Map</code> to be copied
*/
public AttributeMap(Map map)
{
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/CopyOnWriteValueMap.java
URL:
http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/CopyOnWriteValueMap.java?rev=577130&r1=577129&r2=577130&view=diff
==============================================================================
---
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/CopyOnWriteValueMap.java
(original)
+++
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/CopyOnWriteValueMap.java
Tue Sep 18 19:02:25 2007
@@ -28,32 +28,46 @@
/**
- * A implementation that takes a IValueMap that could be immutable but makes a
- * copy when a call is made that wanted to change the map.
+ * An implementation of <code>IValueMap</code> that makes a copy when a caller
+ * tries to change an immutable <code>Map</code>. That is, the
+ * <code>Map</code> may or may not be immutable, but if it is, a copy is made.
*
- * @author jcompagner
+ * @author Johan Compagner
+ * @since 1.2.6
*/
public class CopyOnWriteValueMap implements IValueMap, Serializable
{
private static final long serialVersionUID = 1L;
+ /** the wrapped <code>IValueMap</code> */
private IValueMap wrapped;
/**
- * Construct.
+ * Constructor.
+ *
* @param wrapped
+ * the wrapped <code>IValueMap</code>
*/
public CopyOnWriteValueMap(IValueMap wrapped)
{
this.wrapped = wrapped;
}
+ /**
+ * @see java.util.Map#clear()
+ */
public void clear()
{
checkAndCopy();
wrapped.clear();
}
+ /**
+ * Checks if this <code>IValueMap</code> is immutable. If it is, this
+ * method makes a new <code>IValueMap</code> using the
+ * <code>ValueMap</code> copy constructor, and sets it to be this
+ * <code>CopyOnWriteValueMap</code>.
+ */
private void checkAndCopy()
{
if(wrapped.isImmutable())
@@ -62,156 +76,246 @@
}
}
+ /**
+ * @see java.util.Map#containsKey(Object)
+ */
public boolean containsKey(Object key)
{
return wrapped.containsKey(key);
}
+ /**
+ * @see java.util.Map#containsValue(Object)
+ */
public boolean containsValue(Object value)
{
return wrapped.containsValue(value);
}
+ /**
+ * @see java.util.Map#entrySet()
+ */
public Set entrySet()
{
checkAndCopy();
return wrapped.entrySet();
}
+ /**
+ * @see java.util.Map#equals(Object)
+ */
public boolean equals(Object o)
{
return wrapped.equals(o);
}
+ /**
+ * @see java.util.Map#get(Object)
+ */
public Object get(Object key)
{
return wrapped.get(key);
}
+ /**
+ * @see IValueMap#getBoolean(String)
+ */
public boolean getBoolean(String key) throws
StringValueConversionException
{
return wrapped.getBoolean(key);
}
+ /**
+ * @see IValueMap#getCharSequence(String)
+ */
public CharSequence getCharSequence(String key)
{
return wrapped.getCharSequence(key);
}
+ /**
+ * @see IValueMap#getDouble(String)
+ */
public double getDouble(String key) throws
StringValueConversionException
{
return wrapped.getDouble(key);
}
+ /**
+ * @see IValueMap#getDouble(String, double)
+ */
public double getDouble(String key, double defaultValue) throws
StringValueConversionException
{
return wrapped.getDouble(key, defaultValue);
}
+ /**
+ * @see IValueMap#getDuration(String)
+ */
public Duration getDuration(String key) throws
StringValueConversionException
{
return wrapped.getDuration(key);
}
+ /**
+ * @see IValueMap#getInt(String, int)
+ */
public int getInt(String key, int defaultValue) throws
StringValueConversionException
{
return wrapped.getInt(key, defaultValue);
}
+ /**
+ * @see IValueMap#getInt(String)
+ */
public int getInt(String key) throws StringValueConversionException
{
return wrapped.getInt(key);
}
+ /**
+ * @see IValueMap#getKey(String)
+ */
public String getKey(String key)
{
return wrapped.getKey(key);
}
+ /**
+ * @see IValueMap#getLong(String, long)
+ */
public long getLong(String key, long defaultValue) throws
StringValueConversionException
{
return wrapped.getLong(key, defaultValue);
}
+ /**
+ * @see IValueMap#getLong(String)
+ */
public long getLong(String key) throws StringValueConversionException
{
return wrapped.getLong(key);
}
+ /**
+ * @see IValueMap#getString(String, String)
+ */
public String getString(String key, String defaultValue)
{
return wrapped.getString(key, defaultValue);
}
+ /**
+ * @see IValueMap#getString(String)
+ */
public String getString(String key)
{
return wrapped.getString(key);
}
+ /**
+ * @see IValueMap#getStringArray(String)
+ */
public String[] getStringArray(String key)
{
return wrapped.getStringArray(key);
}
+ /**
+ * @see IValueMap#getStringValue(String)
+ */
public StringValue getStringValue(String key)
{
return wrapped.getStringValue(key);
}
+ /**
+ * @see IValueMap#getTime(String)
+ */
public Time getTime(String key) throws StringValueConversionException
{
return wrapped.getTime(key);
}
+ /**
+ * @see java.util.Map#isEmpty()
+ */
public boolean isEmpty()
{
return wrapped.isEmpty();
}
+ /**
+ * @see IValueMap#isImmutable()
+ */
public boolean isImmutable()
{
return false;
}
+ /**
+ * @see java.util.Map#keySet()
+ */
public Set keySet()
{
checkAndCopy();
return wrapped.keySet();
}
+ /**
+ * @see IValueMap#makeImmutable()
+ */
public IValueMap makeImmutable()
{
return wrapped.makeImmutable();
}
+ /**
+ * @see java.util.Map#put(Object, Object)
+ */
public Object put(Object key, Object value)
{
checkAndCopy();
return wrapped.put(key, value);
}
+ /**
+ * @see java.util.Map#putAll(Map)
+ */
public void putAll(Map map)
{
checkAndCopy();
wrapped.putAll(map);
}
+ /**
+ * @see java.util.Map#remove(Object)
+ */
public Object remove(Object key)
{
checkAndCopy();
return wrapped.remove(key);
}
+ /**
+ * @see java.util.Map#size()
+ */
public int size()
{
return wrapped.size();
}
+ /**
+ * @see java.util.Map#values()
+ */
public Collection values()
{
return wrapped.values();
}
+ /**
+ * @see IValueMap#toString()
+ */
public String toString()
{
return super.toString();
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/Count.java
URL:
http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/Count.java?rev=577130&r1=577129&r2=577130&view=diff
==============================================================================
---
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/Count.java
(original)
+++
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/Count.java
Tue Sep 18 19:02:25 2007
@@ -22,16 +22,19 @@
* A class for counting things.
*
* @author Jonathan Locke
+ * @since 1.2.6
*/
public final class Count implements IClusterable
{
private static final long serialVersionUID = 1L;
- /** The count */
+ /** the count */
private int count = 0;
/**
- * @return Returns the count.
+ * Retrieves the current count value.
+ *
+ * @return the count value
*/
public int getCount()
{
@@ -39,7 +42,7 @@
}
/**
- * Increases the count
+ * Increases the count value by one.
*/
public void increment()
{
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/IValueMap.java
URL:
http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/IValueMap.java?rev=577130&r1=577129&r2=577130&view=diff
==============================================================================
---
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/IValueMap.java
(original)
+++
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/IValueMap.java
Tue Sep 18 19:02:25 2007
@@ -24,12 +24,12 @@
import org.apache.wicket.util.time.Time;
-
/**
- * A Map interface that holds values, parses strings and exposes a variety of
- * convenience methods.
+ * A <code>Map</code> interface that holds values, parses <code>String</code>s,
+ * and exposes a variety of convenience methods.
*
- * @author jcompagner
+ * @author Johan Compagner
+ * @since 1.2.6
*/
public interface IValueMap extends Map
{
@@ -39,165 +39,173 @@
void clear();
/**
- * Gets a boolean value by key.
+ * Retrieves a <code>boolean</code> value by key.
*
* @param key
- * The key
- * @return The value
+ * the key
+ * @return the value
* @throws StringValueConversionException
*/
boolean getBoolean(final String key) throws
StringValueConversionException;
/**
- * Gets a double value by key.
+ * Retrieves a <code>double</code> value by key.
*
* @param key
- * The key
- * @return The value
+ * the key
+ * @return the value
* @throws StringValueConversionException
*/
double getDouble(final String key) throws
StringValueConversionException;
/**
- * Gets a double using a default if not found.
+ * Retrieves a <code>double</code> value by key, using a default value
if
+ * not found.
*
* @param key
- * The key
+ * the key
* @param defaultValue
- * Value to use if no value in map
- * @return The value
+ * value to use if no value is in this <code>IValueMap</code>
+ * @return the value
* @throws StringValueConversionException
*/
double getDouble(final String key, final double defaultValue)
throws StringValueConversionException;
/**
- * Gets a duration.
+ * Retrieves a <code>Duration</code> by key.
*
* @param key
- * The key
- * @return The value
+ * the key
+ * @return the <code>Duration</code> value
* @throws StringValueConversionException
*/
Duration getDuration(final String key) throws
StringValueConversionException;
/**
- * Gets an int.
+ * Retrieves an <code>int</code> value by key.
*
* @param key
- * The key
- * @return The value
+ * the key
+ * @return the value
* @throws StringValueConversionException
*/
int getInt(final String key) throws StringValueConversionException;
/**
- * Gets an int, using a default if not found.
+ * Retrieves an <code>int</code> value by key, using a default value if
+ * not found.
*
* @param key
- * The key
+ * the key
* @param defaultValue
- * Value to use if no value in map
- * @return The value
+ * value to use if no value is in this <code>IValueMap</code>
+ * @return the value
* @throws StringValueConversionException
*/
int getInt(final String key, final int defaultValue) throws
StringValueConversionException;
/**
- * Gets a long.
+ * Retrieves a <code>long</code> value by key.
*
* @param key
- * The key
- * @return The value
+ * the key
+ * @return the value
* @throws StringValueConversionException
*/
long getLong(final String key) throws StringValueConversionException;
/**
- * Gets a long using a default if not found.
+ * Retrieves a <code>long</code> value by key, using a default value if
+ * not found.
*
* @param key
- * The key
+ * the key
* @param defaultValue
- * Value to use if no value in map
- * @return The value
+ * value to use if no value in this <code>IValueMap</code>
+ * @return the value
* @throws StringValueConversionException
*/
long getLong(final String key, final long defaultValue) throws
StringValueConversionException;
/**
- * Gets a string by key.
+ * Retrieves a <code>String</code> by key, using a default value if not
+ * found.
*
* @param key
- * The get
+ * the key
* @param defaultValue
- * Default value to return if value is null
- * @return The string
+ * default value to return if value is <code>null</code>
+ * @return the <code>String</code>
*/
String getString(final String key, final String defaultValue);
/**
- * Gets a string by key.
+ * Retrieves a <code>String</code> by key.
*
* @param key
- * The get
- * @return The string
+ * the key
+ * @return the <code>String</code>
*/
String getString(final String key);
/**
- * Gets a string by key.
+ * Retrieves a <code>CharSequence</code> by key.
*
* @param key
- * The get
- * @return The string
+ * the key
+ * @return the <code>CharSequence</code>
*/
CharSequence getCharSequence(final String key);
/**
- * Gets a String array by key. If the value was a String[] it will be
- * returned directly. If it was a String it will be converted to a
String
- * array of one. If it was an array of another type a String array will
be
- * made and the elements will be converted to a string.
+ * Retrieves a <code>String</code> array by key. If the value was a
+ * <code>String[]</code> it will be returned directly. If it was a
+ * <code>String</code> it will be converted to a <code>String</code>
+ * array of length one. If it was an array of another type, a
+ * <code>String</code> array will be made and each element will be
+ * converted to a <code>String</code>.
*
* @param key
- * @return The String array of that key
+ * the key
+ * @return the <code>String</code> array of that key
*/
String[] getStringArray(final String key);
/**
- * Gets a StringValue by key.
+ * Retrieves a <code>StringValue</code> object by key.
*
* @param key
- * The key
- * @return The string value object
+ * the key
+ * @return the <code>StringValue</code> object
*/
StringValue getStringValue(final String key);
/**
- * Gets a time.
+ * Retrieves a <code>Time</code> object by key.
*
* @param key
- * The key
- * @return The value
+ * the key
+ * @return the <code>Time</code> object
* @throws StringValueConversionException
*/
Time getTime(final String key) throws StringValueConversionException;
/**
- * Gets whether this value map is made immutable.
+ * Returns whether or not this <code>IValueMap</code> is immutable.
*
- * @return whether this value map is made immutable
+ * @return whether or not this <code>IValueMap</code> is immutable
*/
boolean isImmutable();
/**
- * Makes this value map immutable by changing the underlying map
- * representation to a collections "unmodifiableMap". After calling this
- * method, any attempt to modify this map will result in a runtime
exception
- * being thrown by the collections classes.
+ * Makes this <code>IValueMap</code> immutable by changing the
underlying
+ * map representation to a <code>Collections.unmodifiableMap</code>.
+ * After calling this method, any attempt to modify this
+ * <code>IValueMap</code> will result in a <code>RuntimeException</code>
+ * being thrown by the <code>Collections</code> framework.
*
- * @return this
+ * @return this <code>IValueMap</code>
*/
IValueMap makeImmutable();
@@ -217,12 +225,13 @@
Object remove(final Object key);
/**
- * Provided the hash key is a string and you need to access the value
- * ignoring ignoring the keys case (upper or lower letter), than you
may use
- * this method to get the correct writing.
+ * Provided that the hash key is a <code>String</code> and you need to
+ * access the value ignoring the key's case (upper- or lowercase
letters),
+ * then you may use this method to get the correct writing.
*
* @param key
- * @return The key with the correct writing
+ * the key
+ * @return the key with the correct writing
*/
String getKey(final String key);
}
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/IntValue.java
URL:
http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/IntValue.java?rev=577130&r1=577129&r2=577130&view=diff
==============================================================================
---
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/IntValue.java
(original)
+++
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/IntValue.java
Tue Sep 18 19:02:25 2007
@@ -22,24 +22,25 @@
/**
- * A base class for value classes based on a Java int primitive which want to
- * implement standard operations on that value without the pain of aggregating
a
- * Integer object.
+ * A base class based on the Java <code>int</code> primitive for value classes
+ * that want to implement standard operations on that value without the pain of
+ * aggregating an <code>Integer</code> object.
*
* @author Jonathan Locke
+ * @since 1.2.6
*/
public class IntValue implements Comparable, Serializable
{
private static final long serialVersionUID = 1L;
- /** The int value */
+ /** the <code>int</code> value */
protected final int value;
/**
- * Constructor
+ * Constructor.
*
* @param value
- * The int value
+ * the <code>int</code> value
*/
public IntValue(final int value)
{
@@ -69,9 +70,12 @@
}
/**
- * @param that
- * The value to compare against
- * @return True if this value is equal to that value
+ * Compares this <code>Object</code> to a given <code>Object</code>.
+ *
+ * @param object
+ * the <code>Object</code> to compare with
+ * @return 0 if equal, -1 if less than the given <code>Object</code>'s
+ * value, or 1 if greater than given <code>Object</code>'s value
*/
public final boolean equals(final Object that)
{
@@ -84,9 +88,13 @@
}
/**
+ * Compares this <code>IntValue</code> with a primitive <code>int</code>
+ * value.
+ *
* @param value
- * The value to compare against
- * @return True if this value is greater than the given value
+ * the <code>int</code> value to compare with
+ * @return <code>true</code> if this <code>IntValue</code> is greater
+ * than the given <code>int</code> value
*/
public final boolean greaterThan(final int value)
{
@@ -94,9 +102,12 @@
}
/**
+ * Compares this <code>IntValue</code> with another
<code>IntValue</code>.
+ *
* @param that
- * The value to compare against
- * @return True if this value is greater than that value
+ * the <code>IntValue</code> to compare with
+ * @return <code>true</code> if this <code>IntValue</code> is greater
+ * than the given <code>IntValue</code>
*/
public final boolean greaterThan(final IntValue that)
{
@@ -104,7 +115,9 @@
}
/**
- * @return Hashcode for this object
+ * Returns the hash code for this <code>Object</code>.
+ *
+ * @return hash code for this <code>Object</code>
*/
public final int hashCode()
{
@@ -112,9 +125,13 @@
}
/**
- * @param that
- * The value to compare against
- * @return True if this value is less than that value
+ * Compares this <code>IntValue</code> with a primitive <code>int</code>
+ * value.
+ *
+ * @param value
+ * the <code>int</code> value to compare with
+ * @return <code>true</code> if this <code>IntValue</code> is less
+ * than the given <code>int</code> value
*/
public final boolean lessThan(final int that)
{
@@ -122,9 +139,12 @@
}
/**
+ * Compares this <code>IntValue</code> with another
<code>IntValue</code>.
+ *
* @param that
- * The value to compare against
- * @return True if this value is less than that value
+ * the <code>IntValue</code> to compare with
+ * @return <code>true</code> if this <code>IntValue</code> is less
+ * than the given <code>IntValue</code>
*/
public final boolean lessThan(final IntValue that)
{
@@ -132,9 +152,10 @@
}
/**
- * Converts this to a string
+ * Converts this <code>LongValue</code> to a <code>String</code>.
*
- * @return The string for this int value
+ * @return a <code>String</code> representation of this
+ * <code>LongValue</code>
*/
public String toString()
{
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/LongValue.java
URL:
http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/LongValue.java?rev=577130&r1=577129&r2=577130&view=diff
==============================================================================
---
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/LongValue.java
(original)
+++
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/LongValue.java
Tue Sep 18 19:02:25 2007
@@ -22,24 +22,25 @@
/**
- * A base class for value classes based on a Java long primitive which want to
- * implement standard operations on that value without the pain of aggregating
a
- * Long object.
+ * A base class based on the Java <code>long</code> primitive for value
+ * classes that want to implement standard operations on that value without the
+ * pain of aggregating a <code>Long</code> object.
*
* @author Jonathan Locke
+ * @since 1.2.6
*/
public class LongValue implements Comparable, Serializable
{
private static final long serialVersionUID = 1L;
- /** The long value */
+ /** the <code>long</code> value */
protected final long value;
/**
- * Constructor
+ * Constructor.
*
* @param value
- * The long value
+ * the <code>long</code> value
*/
public LongValue(final long value)
{
@@ -47,9 +48,12 @@
}
/**
+ * Compares this <code>Object</code> to a given <code>Object</code>.
+ *
* @param object
- * The object to compare with
- * @return 0 if equal, -1 if less than or 1 if greater than
+ * the <code>Object</code> to compare with
+ * @return 0 if equal, -1 if less than the given <code>Object</code>'s
+ * value, or 1 if greater than given <code>Object</code>'s value
*/
public final int compareTo(final Object object)
{
@@ -69,9 +73,12 @@
}
/**
+ * Tests for equality.
+ *
* @param that
- * The value to compare against
- * @return True if this value is equal to that value
+ * the <code>Object</code> to compare with
+ * @return <code>true</code> if this <code>Object</code>'s value is
+ * equal to the given <code>Object</code>'s value
*/
public final boolean equals(final Object that)
{
@@ -84,9 +91,13 @@
}
/**
+ * Compares this <code>LongValue</code> with a primitive
<code>long</code>
+ * value.
+ *
* @param value
- * The value to compare against
- * @return True if this value is greater than the given value
+ * the <code>long</code> value to compare with
+ * @return <code>true</code> if this <code>LongValue</code> is greater
+ * than the given <code>long</code> value
*/
public final boolean greaterThan(final long value)
{
@@ -94,9 +105,13 @@
}
/**
+ * Compares this <code>LongValue</code> with another
+ * <code>LongValue</code>.
+ *
* @param that
- * The value to compare against
- * @return True if this value is greater than that value
+ * the <code>LongValue</code> to compare with
+ * @return <code>true</code> if this <code>LongValue</code> is greater
+ * than the given <code>LongValue</code>
*/
public final boolean greaterThan(final LongValue that)
{
@@ -104,7 +119,9 @@
}
/**
- * @return Hashcode for this object
+ * Returns the hash code for this <code>Object</code>.
+ *
+ * @return hash code for this <code>Object</code>
*/
public final int hashCode()
{
@@ -112,9 +129,13 @@
}
/**
+ * Compares this <code>LongValue</code> with a primitive
<code>long</code>
+ * value.
+ *
* @param that
- * The value to compare against
- * @return True if this value is less than that value
+ * the <code>long</code> value to compare with
+ * @return <code>true</code> if this <code>LongValue</code> is less than
+ * the given <code>long</code> value
*/
public final boolean lessThan(final long that)
{
@@ -122,9 +143,13 @@
}
/**
+ * Compares this <code>LongValue</code> with another
+ * <code>LongValue</code>.
+ *
* @param that
- * The value to compare against
- * @return True if this value is less than that value
+ * the <code>LongValue</code> value to compare with
+ * @return <code>true</code> if this <code>LongValue</code> is less than
+ * the given <code>LongValue</code>
*/
public final boolean lessThan(final LongValue that)
{
@@ -132,9 +157,10 @@
}
/**
- * Converts this value to a string
+ * Converts this <code>LongValue</code> to a <code>String</code>.
*
- * @return The string for this value
+ * @return a <code>String</code> representation of this
+ * <code>LongValue</code>
*/
public String toString()
{
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/ValueMap.java
URL:
http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/ValueMap.java?rev=577130&r1=577129&r2=577130&view=diff
==============================================================================
---
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/ValueMap.java
(original)
+++
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/ValueMap.java
Tue Sep 18 19:02:25 2007
@@ -33,38 +33,46 @@
/**
- * A Map implementation that holds values, parses strings and exposes a variety
- * of convenience methods.
+ * A <code>IValueMap</code> implementation that holds values, parses
+ * <code>String</code>s, and exposes a variety of convenience methods.
* <p>
- * In addition to a no-arg constructor and a copy constructor that takes a Map
- * argument, ValueMaps can be constructed using a parsing constructor.
- * ValueMap(String) will parse values from the string in comma separated
- * key/value assignment pairs. For example, new ValueMap("a=9,b=foo").
+ * In addition to a no-arg constructor and a copy constructor that takes a
+ * <code>Map</code> argument, <code>ValueMap</code>s can be constructed
+ * using a parsing constructor. <code>ValueMap(String)</code> will parse
+ * values from the string in comma separated key/value assignment pairs. For
+ * example, <code>new ValueMap("a=9,b=foo")</code>.
* <p>
- * Values can be retrieved from the map in the usual way or with methods that
do
- * handy conversions to various types, including String, StringValue, int,
long,
- * double, Time and Duration.
+ * Values can be retrieved from the <code>ValueMap</code> in the usual way or
+ * with methods that do handy conversions to various types, including
+ * <code>String</code>, <code>StringValue</code>, <code>int</code>,
+ * <code>long</code>, <code>double</code>, <code>Time</code> and
+ * <code>Duration</code>.
* <p>
- * The makeImmutable method will make the underlying map immutable. Further
- * attempts to change the map will result in a runtime exception.
+ * The <code>makeImmutable</code> method will make the underlying
+ * <code>Map</code> immutable. Further attempts to change the <code>Map</code>
+ * will result in a <code>RuntimeException</code>.
* <p>
- * The toString() method converts a ValueMap object to a readable key/value
- * string for diagnostics.
+ * The <code>toString</code> method converts a <code>ValueMap</code> object
+ * to a readable key/value string for diagnostics.
*
* @author Jonathan Locke
+ * @since 1.2.6
*/
public class ValueMap extends HashMap implements IValueMap
{
- /** An empty ValueMap. */
+ /** an empty <code>ValueMap</code>. */
public static final ValueMap EMPTY_MAP = new ValueMap();
private static final long serialVersionUID = 1L;
- /** True if this value map has been made immutable. */
+ /**
+ * <code>true</code> if this <code>ValueMap</code> has been made
+ * immutable.
+ */
private boolean immutable = false;
/**
- * Constructs empty value map.
+ * Constructs empty <code>ValueMap</code>.
*/
public ValueMap()
{
@@ -74,7 +82,7 @@
* Copy constructor.
*
* @param map
- * The map to copy
+ * the <code>ValueMap</code> to copy
*/
public ValueMap(final Map map)
{
@@ -82,12 +90,14 @@
}
/**
- * Constructor. NOTE: Please use RequestUtils.decodeParameters() if you
wish
- * to properly decode a request URL.
+ * Constructor.
+ * <p>
+ * NOTE: Please use <code>RequestUtils.decodeParameters()</code> if you
+ * wish to properly decode a request URL.
*
* @param keyValuePairs
- * List of key value pairs separated by commas. For example,
- * "param1=foo,param2=bar"
+ * list of key/value pairs separated by commas.
+ * For example, "<code>param1=foo,param2=bar</code>"
*/
public ValueMap(final String keyValuePairs)
{
@@ -95,14 +105,18 @@
}
/**
- * Constructor. NOTE: Please use RequestUtils.decodeParameters() if you
wish
- * to properly decode a request URL.
+ * Constructor.
+ * <p>
+ * NOTE: Please use <code>RequestUtils.decodeParameters()</code> if you
+ * wish to properly decode a request URL.
*
* @param keyValuePairs
- * List of key value pairs separated by a given delimiter.
For
- * example, "param1=foo,param2=bar" where delimiter is ",".
+ * list of key/value pairs separated by a given delimiter.
For
+ * example, "<code>param1=foo,param2=bar</code>" where
+ * delimiter is "<code>,</code>".
* @param delimiter
- * Delimiter string used to separate key/value pairs
+ * delimiter <code>String</code> used to separate key/value
+ * pairs
*/
public ValueMap(final String keyValuePairs, final String delimiter)
{
@@ -155,13 +169,14 @@
* Constructor.
*
* @param keyValuePairs
- * List of key value pairs separated by a given delimiter.
For
- * example, "param1=foo,param2=bar" where delimiter is ",".
+ * list of key/value pairs separated by a given delimiter.
For
+ * example, "<code>param1=foo,param2=bar</code>" where
+ * delimiter is "<code>,</code>".
* @param delimiter
- * Delimiter string used to separate key/value pairs
+ * delimiter string used to separate key/value pairs
* @param valuePattern
- * Pattern for value. To pass a simple regular expression
pass
- * "new MetaPattern(regexp)".
+ * pattern for value. To pass a simple regular expression,
+ * pass "<code>new MetaPattern(regexp)</code>".
*/
public ValueMap(final String keyValuePairs, final String delimiter,
final MetaPattern valuePattern)
@@ -202,12 +217,7 @@
}
/**
- * Gets a boolean value by key.
- *
- * @param key
- * The key
- * @return The value
- * @throws StringValueConversionException
+ * @see IValueMap#getBoolean(String)
*/
public final boolean getBoolean(final String key) throws
StringValueConversionException
{
@@ -215,12 +225,7 @@
}
/**
- * Gets a double value by key.
- *
- * @param key
- * The key
- * @return The value
- * @throws StringValueConversionException
+ * @see IValueMap#getDouble(String)
*/
public final double getDouble(final String key) throws
StringValueConversionException
{
@@ -228,14 +233,7 @@
}
/**
- * Gets a double using a default if not found.
- *
- * @param key
- * The key
- * @param defaultValue
- * Value to use if no value in map
- * @return The value
- * @throws StringValueConversionException
+ * @see IValueMap#getDouble(String, double)
*/
public final double getDouble(final String key, final double
defaultValue)
throws StringValueConversionException
@@ -244,12 +242,7 @@
}
/**
- * Gets a duration.
- *
- * @param key
- * The key
- * @return The value
- * @throws StringValueConversionException
+ * @see IValueMap#getDuration(String)
*/
public final Duration getDuration(final String key) throws
StringValueConversionException
{
@@ -257,12 +250,7 @@
}
/**
- * Gets an int.
- *
- * @param key
- * The key
- * @return The value
- * @throws StringValueConversionException
+ * @see IValueMap#getInt(String)
*/
public final int getInt(final String key) throws
StringValueConversionException
{
@@ -270,14 +258,7 @@
}
/**
- * Gets an int, using a default if not found.
- *
- * @param key
- * The key
- * @param defaultValue
- * Value to use if no value in map
- * @return The value
- * @throws StringValueConversionException
+ * @see IValueMap#getInt(String, int)
*/
public final int getInt(final String key, final int defaultValue)
throws StringValueConversionException
@@ -286,12 +267,7 @@
}
/**
- * Gets a long.
- *
- * @param key
- * The key
- * @return The value
- * @throws StringValueConversionException
+ * @see IValueMap#getLong(String)
*/
public final long getLong(final String key) throws
StringValueConversionException
{
@@ -299,14 +275,7 @@
}
/**
- * Gets a long using a default if not found.
- *
- * @param key
- * The key
- * @param defaultValue
- * Value to use if no value in map
- * @return The value
- * @throws StringValueConversionException
+ * @see IValueMap#getLong(String, long)
*/
public final long getLong(final String key, final long defaultValue)
throws StringValueConversionException
@@ -315,13 +284,7 @@
}
/**
- * Gets a string by key.
- *
- * @param key
- * The get
- * @param defaultValue
- * Default value to return if value is null
- * @return The string
+ * @see IValueMap#getString(String, String)
*/
public final String getString(final String key, final String
defaultValue)
{
@@ -330,11 +293,7 @@
}
/**
- * Gets a string by key.
- *
- * @param key
- * The get
- * @return The string
+ * @see IValueMap#getString(String)
*/
public final String getString(final String key)
{
@@ -364,11 +323,7 @@
}
/**
- * Gets a string by key.
- *
- * @param key
- * The get
- * @return The string
+ * @see IValueMap#getCharSequence(String)
*/
public final CharSequence getCharSequence(final String key)
{
@@ -406,13 +361,7 @@
}
/**
- * Gets a String array by key. If the value was a String[] it will be
- * returned directly. If it was a String it will be converted to a
String
- * array of one. If it was an array of another type a String array will
be
- * made and the elements will be converted to a string.
- *
- * @param key
- * @return The String array of that key
+ * @see IValueMap#getStringArray(String)
*/
public String[] getStringArray(final String key)
{
@@ -443,11 +392,7 @@
}
/**
- * Gets a StringValue by key.
- *
- * @param key
- * The key
- * @return The string value object
+ * @see IValueMap#getStringValue(String)
*/
public StringValue getStringValue(final String key)
{
@@ -455,12 +400,7 @@
}
/**
- * Gets a time.
- *
- * @param key
- * The key
- * @return The value
- * @throws StringValueConversionException
+ * @see IValueMap#getTime(String)
*/
public final Time getTime(final String key) throws
StringValueConversionException
{
@@ -468,9 +408,7 @@
}
/**
- * Gets whether this value map is made immutable.
- *
- * @return whether this value map is made immutable
+ * @see IValueMap#isImmutable()
*/
public final boolean isImmutable()
{
@@ -478,10 +416,7 @@
}
/**
- * Makes this value map immutable by changing the underlying map
- * representation to a collections "unmodifiableMap". After calling this
- * method, any attempt to modify this map will result in a runtime
exception
- * being thrown by the collections classes.
+ * @see IValueMap#makeImmutable()
*/
public final IValueMap makeImmutable()
{
@@ -499,16 +434,18 @@
}
/**
- * This methods adds the value to this map under the given key If the
key
- * already is in the map it will combine the values into a String array
else
- * it will just store the value itself
+ * Adds the value to this <code>ValueMap</code> with the given key. If
the
+ * key already is in the <code>ValueMap</code> it will combine the
values
+ * into a <code>String</code> array, else it will just store the value
+ * itself.
*
* @param key
- * The key to store the value under.
+ * the key to store the value under
* @param value
- * The value that must be added/merged to the map
- * @return The value itself if there was no previous value or a string
array
- * with the combined values.
+ * the value that must be added/merged to the
+ * <code>ValueMap</code>
+ * @return the value itself if there was no previous value, or a
+ * <code>String</code> array with the combined values
*/
public final Object add(final String key, final String value)
{
@@ -559,12 +496,7 @@
}
/**
- * Provided the hash key is a string and you need to access the value
- * ignoring ignoring the keys case (upper or lower letter), than you
may use
- * this method to get the correct writing.
- *
- * @param key
- * @return The key with the correct writing
+ * @see IValueMap#getKey(String)
*/
public String getKey(final String key)
{
@@ -585,10 +517,11 @@
}
/**
- * Gets a string representation of this object
+ * Generates a <code>String</code> representation of this object.
*
- * @return String representation of map consistent with tag attribute
style
- * of markup elements, for example: a="x" b="y" c="z"
+ * @return <code>String</code> representation of this
+ * <code>ValueMap</code> consistent with the tag-attribute style
+ * of markup elements. For example: <code>a="x" b="y"
c="z"</code>.
*/
public String toString()
{
@@ -622,7 +555,7 @@
}
/**
- * Throw exception if map is immutable.
+ * Throws an exception if <code>ValueMap</code> is immutable.
*/
private final void checkMutability()
{
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/package.html
URL:
http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/package.html?rev=577130&r1=577129&r2=577130&view=diff
==============================================================================
---
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/package.html
(original)
+++
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/value/package.html
Tue Sep 18 19:02:25 2007
@@ -16,12 +16,14 @@
-->
<!DOCTYPE HTML PUBLIC "-//W3C/DTD HTML 3.2 Final//NL">
<html>
-<head>
-<title>wicket.util.value package</title>
-</head>
-<body>
-<p>
-Casting utilities.
-</p>
-</body>
+ <head>
+ <title>
+ org.apache.wicket.util.value package
+ </title>
+ </head>
+ <body>
+ <p>
+ This package provides casting utilities.
+ </p>
+ </body>
</html>
