Java Doc for PredicatedCollection.java in » Library » Apache-common-Collections » org » apache » commons » collections » collection » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Library » Apache common Collections » org.apache.commons.collections.collection

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.commons.collections.collection .AbstractCollectionDecorator

org.apache.commons.collections.collection .AbstractSerializableCollectionDecorator

org.apache.commons.collections.collection .PredicatedCollection

All known Subclasses:   org.apache.commons.collections.set .PredicatedSet,  org.apache.commons.collections.buffer .PredicatedBuffer,  org.apache.commons.collections.bag .PredicatedBag,  org.apache.commons.collections.list .PredicatedList,
PredicatedCollection
public class PredicatedCollection extends AbstractSerializableCollectionDecorator (Code)
Decorates another Collection to validate that additions match a specified predicate.
This collection exists to provide validation for the decorated collection. It is normally created to decorate an empty collection. If an object cannot be added to the collection, an IllegalArgumentException is thrown.
One usage would be to ensure that no null entries are added to the collection.
Collection coll = PredicatedCollection.decorate(new ArrayList(), NotNullPredicate.INSTANCE);

This class is Serializable from Commons Collections 3.1.
since:
   Commons Collections 3.0
version:
   $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
author:
   Stephen Colebourne
author:
   Paul Jack

Field Summary
final protected Predicate predicate


Constructor Summary
protected PredicatedCollection(Collection coll, Predicate predicate)
     Constructor that wraps (not copies).

Method Summary
public boolean add(Object object)
     Override to validate the object being added to ensure it matches the predicate.
public boolean addAll(Collection coll)
     Override to validate the objects being added to ensure they match the predicate.
public static Collection decorate(Collection coll, Predicate predicate)
     Factory method to create a predicated (validating) collection.
protected void validate(Object object)
     Validates the object being added to ensure it matches the predicate.

Field Detail
predicate
final protected Predicate predicate(Code)
The predicate to use

Constructor Detail
PredicatedCollection
protected PredicatedCollection(Collection coll, Predicate predicate)(Code)
Constructor that wraps (not copies).
If there are any elements already in the collection being decorated, they are validated.
Parameters:
  coll - the collection to decorate, must not be null
Parameters:
  predicate - the predicate to use for validation, must not be null
throws:
  IllegalArgumentException - if collection or predicate is null
throws:
  IllegalArgumentException - if the collection contains invalid elements

Method Detail
add
public boolean add(Object object)(Code)
Override to validate the object being added to ensure it matches the predicate.
Parameters:
  object - the object being added the result of adding to the underlying collection
throws:
  IllegalArgumentException - if the add is invalid

addAll
public boolean addAll(Collection coll)(Code)
Override to validate the objects being added to ensure they match the predicate. If any one fails, no update is made to the underlying collection.
Parameters:
  coll - the collection being added the result of adding to the underlying collection
throws:
  IllegalArgumentException - if the add is invalid

decorate
public static Collection decorate(Collection coll, Predicate predicate)(Code)
Factory method to create a predicated (validating) collection.
If there are any elements already in the collection being decorated, they are validated.
Parameters:
  coll - the collection to decorate, must not be null
Parameters:
  predicate - the predicate to use for validation, must not be null a new predicated collection
throws:
  IllegalArgumentException - if collection or predicate is null
throws:
  IllegalArgumentException - if the collection contains invalid elements

validate
protected void validate(Object object)(Code)
Validates the object being added to ensure it matches the predicate.
The predicate itself should not throw an exception, but return false to indicate that the object cannot be added.
Parameters:
  object - the object being added
throws:
  IllegalArgumentException - if the add is invalid

Fields inherited from org.apache.commons.collections.collection.AbstractCollectionDecorator
protected Collection collection(Code)(Java Doc)

Methods inherited from org.apache.commons.collections.collection.AbstractCollectionDecorator
public boolean add(Object object)(Code)(Java Doc)
public boolean addAll(Collection coll)(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public boolean contains(Object object)(Code)(Java Doc)
public boolean containsAll(Collection coll)(Code)(Java Doc)
public boolean equals(Object object)(Code)(Java Doc)
protected Collection getCollection()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)
public Iterator iterator()(Code)(Java Doc)
public boolean remove(Object object)(Code)(Java Doc)
public boolean removeAll(Collection coll)(Code)(Java Doc)
public boolean retainAll(Collection coll)(Code)(Java Doc)
public int size()(Code)(Java Doc)
public Object[] toArray()(Code)(Java Doc)
public Object[] toArray(Object[] object)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.