Improve documentation
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131130 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
75f96422de
commit
b8dba646f1
|
@ -9,16 +9,17 @@ The following decorator types are provided in the package:
|
||||||
<li>Unmodifiable - ensures the collection cannot be altered
|
<li>Unmodifiable - ensures the collection cannot be altered
|
||||||
<li>Predicated - ensures that only elements that are valid according to a predicate can be added
|
<li>Predicated - ensures that only elements that are valid according to a predicate can be added
|
||||||
<li>Typed - ensures that only elements that are of a specific type can be added
|
<li>Typed - ensures that only elements that are of a specific type can be added
|
||||||
<li>Lazy - creates objects in the collection on demand
|
|
||||||
<li>FixedSize - ensures that the size of the collection cannot change
|
|
||||||
<li>Blocking - blocks until data available when calling get() on an empty collection
|
<li>Blocking - blocks until data available when calling get() on an empty collection
|
||||||
|
<li>FixedSize - ensures that the size of the collection cannot change
|
||||||
|
<li>Lazy - creates objects in the collection on demand
|
||||||
|
<li>Ordered - ensures that insertion order is remembered in a Map/Set
|
||||||
</ul>
|
</ul>
|
||||||
<p>
|
<p>
|
||||||
Each collection can be constructed using a static <code>decorate()</code> method on
|
Each collection can be constructed using a static <code>decorate()</code> method on
|
||||||
the class. They can also be constructed from the <code>XxxUtils</code> class where
|
the class. They can also be constructed from the <code>XxxUtils</code> class where
|
||||||
Xxx is the collection type.
|
Xxx is the collection type.
|
||||||
<pre>
|
<pre>
|
||||||
List stringOnlyList = TypedList(new ArrayList(), String.class);
|
List stringOnlyList = TypedList.decorate(new ArrayList(), String.class);
|
||||||
List otherStringOnlyList = ListUtils.typedList(new ArrayList(), String.class);
|
List otherStringOnlyList = ListUtils.typedList(new ArrayList(), String.class);
|
||||||
</pre>
|
</pre>
|
||||||
</BODY>
|
</BODY>
|
||||||
|
|
Loading…
Reference in New Issue