Java Doc for PredicatedMap.java in  » Library » Apache-common-Collections » org » apache » commons » collections » map » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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.map 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.collections.map.AbstractMapDecorator
      org.apache.commons.collections.map.AbstractInputCheckedMapDecorator
         org.apache.commons.collections.map.PredicatedMap

All known Subclasses:   org.apache.commons.collections.map.PredicatedSortedMap,
PredicatedMap
public class PredicatedMap extends AbstractInputCheckedMapDecorator implements Serializable(Code)
Decorates another Map to validate that additions match a specified predicate.

This map exists to provide validation for the decorated map. It is normally created to decorate an empty map. If an object cannot be added to the map, an IllegalArgumentException is thrown.

One usage would be to ensure that no null keys are added to the map.

Map map = PredicatedSet.decorate(new HashMap(), NotNullPredicate.INSTANCE, null);

Note that PredicatedMap is not synchronized and is not thread-safe. If you wish to use this map from multiple threads concurrently, you must use appropriate synchronization. The simplest approach is to wrap this map using java.util.Collections.synchronizedMap(Map) . This class may throw exceptions when accessed by concurrent threads without synchronization.

This class is Serializable from Commons Collections 3.1.
since:
   Commons Collections 3.0
version:
   $Revision: 348007 $ $Date: 2005-11-21 22:52:57 +0000 (Mon, 21 Nov 2005) $
author:
   Stephen Colebourne
author:
   Paul Jack



Field Summary
final protected  PredicatekeyPredicate
    
final protected  PredicatevaluePredicate
    

Constructor Summary
protected  PredicatedMap(Map map, Predicate keyPredicate, Predicate valuePredicate)
     Constructor that wraps (not copies).

Method Summary
protected  ObjectcheckSetValue(Object value)
     Override to validate an object set into the map via setValue.
public static  Mapdecorate(Map map, Predicate keyPredicate, Predicate valuePredicate)
     Factory method to create a predicated (validating) map.
protected  booleanisSetValueChecking()
     Override to only return true when there is a value transformer.
public  Objectput(Object key, Object value)
    
public  voidputAll(Map mapToCopy)
    
protected  voidvalidate(Object key, Object value)
     Validates a key value pair.

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



valuePredicate
final protected Predicate valuePredicate(Code)
The value predicate to use




Constructor Detail
PredicatedMap
protected PredicatedMap(Map map, Predicate keyPredicate, Predicate valuePredicate)(Code)
Constructor that wraps (not copies).
Parameters:
  map - the map to decorate, must not be null
Parameters:
  keyPredicate - the predicate to validate the keys, null means no check
Parameters:
  valuePredicate - the predicate to validate to values, null means no check
throws:
  IllegalArgumentException - if the map is null




Method Detail
checkSetValue
protected Object checkSetValue(Object value)(Code)
Override to validate an object set into the map via setValue.
Parameters:
  value - the value to validate
throws:
  IllegalArgumentException - if invalid
since:
   Commons Collections 3.1



decorate
public static Map decorate(Map map, Predicate keyPredicate, Predicate valuePredicate)(Code)
Factory method to create a predicated (validating) map.

If there are any elements already in the list being decorated, they are validated.
Parameters:
  map - the map to decorate, must not be null
Parameters:
  keyPredicate - the predicate to validate the keys, null means no check
Parameters:
  valuePredicate - the predicate to validate to values, null means no check
throws:
  IllegalArgumentException - if the map is null




isSetValueChecking
protected boolean isSetValueChecking()(Code)
Override to only return true when there is a value transformer. true if a value predicate is in use
since:
   Commons Collections 3.1



put
public Object put(Object key, Object value)(Code)



putAll
public void putAll(Map mapToCopy)(Code)



validate
protected void validate(Object key, Object value)(Code)
Validates a key value pair.
Parameters:
  key - the key to validate
Parameters:
  value - the value to validate
throws:
  IllegalArgumentException - if invalid



Methods inherited from org.apache.commons.collections.map.AbstractInputCheckedMapDecorator
abstract protected Object checkSetValue(Object value)(Code)(Java Doc)
public Set entrySet()(Code)(Java Doc)
protected boolean isSetValueChecking()(Code)(Java Doc)

Fields inherited from org.apache.commons.collections.map.AbstractMapDecorator
protected transient Map map(Code)(Java Doc)

Methods inherited from org.apache.commons.collections.map.AbstractMapDecorator
public void clear()(Code)(Java Doc)
public boolean containsKey(Object key)(Code)(Java Doc)
public boolean containsValue(Object value)(Code)(Java Doc)
public Set entrySet()(Code)(Java Doc)
public boolean equals(Object object)(Code)(Java Doc)
public Object get(Object key)(Code)(Java Doc)
protected Map getMap()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)
public Set keySet()(Code)(Java Doc)
public Object put(Object key, Object value)(Code)(Java Doc)
public void putAll(Map mapToCopy)(Code)(Java Doc)
public Object remove(Object key)(Code)(Java Doc)
public int size()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public Collection values()(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
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.