Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove again unneeded closing p tags to keep consistency. 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1353163 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart 2012-06-23 17:02:29 +00:00
parent 5755bebf5d
commit 7f0c6e905a
5 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/main/java/org/apache/commons/collections/Bag.java
View File

@ -26,17 +26,17 @@ import java.util.Set;
* <p>
* Suppose you have a Bag that contains <code>{a, a, b, c}</code>.
* Calling {@link #getCount(Object)} on <code>a</code> would return 2, while
* calling {@link #uniqueSet()} would return <code>{a, b, c}</code>.</p>
* calling {@link #uniqueSet()} would return <code>{a, b, c}</code>.
* <p>
* <i>NOTE: This interface violates the {@link Collection} contract.</i>
* The behavior specified in many of these methods is <i>not</i> the same
* as the behavior specified by <code>Collection</code>.
* The noncompliant methods are clearly marked with "(Violation)".
* Exercise caution when using a bag as a <code>Collection</code>.</p>
* Exercise caution when using a bag as a <code>Collection</code>.
* <p>
* This violation resulted from the original specification of this interface.
* In an ideal world, the interface would be changed to fix the problems, however
* it has been decided to maintain backwards compatibility instead.</p>
* it has been decided to maintain backwards compatibility instead.
*
* @param <E> the type held in the bag
* @since Commons Collections 2.0
@ -63,12 +63,12 @@ public interface Bag<E> extends Collection<E> {
* <p>
* If the object is already in the {@link #uniqueSet()} then increment its
* count as reported by {@link #getCount(Object)}. Otherwise add it to the
* {@link #uniqueSet()} and report its count as 1.</p>
* {@link #uniqueSet()} and report its count as 1.
* <p>
* Since this method always increases the size of the bag,
* according to the {@link Collection#add(Object)} contract, it
* should always return <code>true</code>. Since it sometimes returns
* <code>false</code>, this method violates the contract.</p>
* <code>false</code>, this method violates the contract.
*
* @param object the object to add
* @return <code>true</code> if the object was not already in the <code>uniqueSet</code>
@ -80,7 +80,7 @@ public interface Bag<E> extends Collection<E> {
* <p>
* If the object is already in the {@link #uniqueSet()} then increment its
* count as reported by {@link #getCount(Object)}. Otherwise add it to the
* {@link #uniqueSet()} and report its count as <code>nCopies</code>.</p>
* {@link #uniqueSet()} and report its count as <code>nCopies</code>.
*
* @param object the object to add
* @param nCopies the number of copies to add
@ -92,11 +92,11 @@ public interface Bag<E> extends Collection<E> {
* <i>(Violation)</i>
* Removes all occurrences of the given object from the bag.
* <p>
* This will also remove the object from the {@link #uniqueSet()}.</p>
* This will also remove the object from the {@link #uniqueSet()}.
* <p>
* According to the {@link Collection#remove(Object)} method,
* this method should only remove the <i>first</i> occurrence of the
* given object, not <i>all</i> occurrences.</p>
* given object, not <i>all</i> occurrences.
*
* @param object the object to remove
* @return <code>true</code> if this call changed the collection
@ -107,7 +107,7 @@ public interface Bag<E> extends Collection<E> {
* Removes <code>nCopies</code> copies of the specified object from the Bag.
* <p>
* If the number of copies to remove is greater than the actual number of
* copies in the Bag, no error is thrown.</p>
* copies in the Bag, no error is thrown.
*
* @param object the object to remove
* @param nCopies the number of copies to remove
@ -118,7 +118,7 @@ public interface Bag<E> extends Collection<E> {
/**
* Returns a {@link Set} of unique elements in the Bag.
* <p>
* Uniqueness constraints are the same as those in {@link java.util.Set}.</p>
* Uniqueness constraints are the same as those in {@link java.util.Set}.
*
* @return the Set of unique Bag elements
*/
@ -142,7 +142,7 @@ public interface Bag<E> extends Collection<E> {
* The {@link Collection#containsAll(Collection)} method specifies
* that cardinality should <i>not</i> be respected; this method should
* return true if the bag contains at least one of every object contained
* in the given collection.</p>
* in the given collection.
*
* @param coll the collection to check against
* @return <code>true</code> if the Bag contains all the collection
@ -160,7 +160,7 @@ public interface Bag<E> extends Collection<E> {
* <p>The {@link Collection#removeAll(Collection)} method specifies
* that cardinality should <i>not</i> be respected; this method should
* remove <i>all</i> occurrences of every object contained in the
* given collection.</p>
* given collection.
*
* @param coll the collection to remove
* @return <code>true</code> if this call changed the collection
@ -181,7 +181,7 @@ public interface Bag<E> extends Collection<E> {
* <p>The {@link Collection#retainAll(Collection)} method specifies
* that cardinality should <i>not</i> be respected; this method should
* keep <i>all</i> occurrences of every object contained in the
* given collection.</p>
* given collection.
*
* @param coll the collection to retain
* @return <code>true</code> if this call changed the collection

6
src/main/java/org/apache/commons/collections/Buffer.java
View File

@ -23,17 +23,17 @@ import java.util.Collection;
* <p>
* The removal order can be based on insertion order (eg, a FIFO queue or a
* LIFO stack), on access order (eg, an LRU cache), on some arbitrary comparator
* (eg, a priority queue) or on any other well-defined ordering.</p>
* (eg, a priority queue) or on any other well-defined ordering.
* <p>
* Note that the removal order is not necessarily the same as the iteration
* order. A <code>Buffer</code> implementation may have equivalent removal
* and iteration orders, but this is not required.</p>
* and iteration orders, but this is not required.
* <p>
* This interface does not specify any behavior for
* {@link Object#equals(Object)} and {@link Object#hashCode} methods. It
* is therefore possible for a <code>Buffer</code> implementation to also
* also implement {@link java.util.List}, {@link java.util.Set} or
* {@link Bag}.</p>
* {@link Bag}.
*
* @param <E> the type of the elements in the buffer
* @since Commons Collections 2.1

4
src/main/java/org/apache/commons/collections/Closure.java
View File

@ -20,10 +20,10 @@ package org.apache.commons.collections;
* Defines a functor interface implemented by classes that do something.
* <p>
* A <code>Closure</code> represents a block of code which is executed from
* inside some block, function or iteration. It operates an input object.</p>
* inside some block, function or iteration. It operates an input object.
* <p>
* Standard implementations of common closures are provided by
* {@link ClosureUtils}. These include method invocation and for/while loops.</p>
* {@link ClosureUtils}. These include method invocation and for/while loops.
*
* @param <T> the type that the closure acts on
* @since Commons Collections 1.0

4
src/main/java/org/apache/commons/collections/Factory.java
View File

@ -20,11 +20,11 @@ package org.apache.commons.collections;
* Defines a functor interface implemented by classes that create objects.
* <p>
* A <code>Factory</code> creates an object without using an input parameter.
* If an input parameter is required, then {@link Transformer} is more appropriate.</p>
* If an input parameter is required, then {@link Transformer} is more appropriate.
* <p>
* Standard implementations of common factories are provided by
* {@link FactoryUtils}. These include factories that return a constant,
* a copy of a prototype or a new instance.</p>
* a copy of a prototype or a new instance.
*
* @param <T> the type that the factory creates
*

8
src/main/java/org/apache/commons/collections/MultiMap.java
View File

@ -23,7 +23,7 @@ import java.util.Collection;
* <p>
* A <code>MultiMap</code> is a Map with slightly different semantics.
* Putting a value into the map will add the value to a Collection at that key.
* Getting a value will return a Collection, holding all the values put to that key.</p>
* Getting a value will return a Collection, holding all the values put to that key.
* <p>
* For example:
* <pre>
@ -31,13 +31,13 @@ import java.util.Collection;
* mhm.put(key, "A");
* mhm.put(key, "B");
* mhm.put(key, "C");
* Collection coll = (Collection) mhm.get(key);</pre></p>
* Collection coll = (Collection) mhm.get(key);</pre>
* <p>
* <code>coll</code> will be a collection containing "A", "B", "C".</p>
* <code>coll</code> will be a collection containing "A", "B", "C".
* <p>
* NOTE: Additional methods were added to this interface in Commons Collections 3.1.
* These were added solely for documentation purposes and do not change the interface
* as they were defined in the superinterface <code>Map</code> anyway.</p>
* as they were defined in the superinterface <code>Map</code> anyway.
*
* @since Commons Collections 2.0
* @version $Revision$