Java Doc for ListOrderedSet.java in  » Library » Apache-common-Collections » org » apache » commons » collections » set » 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.set 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.commons.collections.set.AbstractSetDecorator
   org.apache.commons.collections.set.AbstractSerializableSetDecorator
      org.apache.commons.collections.set.ListOrderedSet

ListOrderedSet
public class ListOrderedSet extends AbstractSerializableSetDecorator implements Set(Code)
Decorates another Set to ensure that the order of addition is retained and used by the iterator.

If an object is added to the set for a second time, it will remain in the original position in the iteration. The order can be observed from the set via the iterator or toArray methods.

The ListOrderedSet also has various useful direct methods. These include many from List, such as get(int), remove(int) and indexOf(int). An unmodifiable List view of the set can be obtained via asList().

This class cannot implement the List interface directly as various interface methods (notably equals/hashCode) are incompatable with a set.

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:
   Henning P. Schmiedehausen


Inner Class :static class OrderedSetIterator extends AbstractIteratorDecorator

Field Summary
final protected  ListsetOrder
    

Constructor Summary
public  ListOrderedSet()
     Constructs a new empty ListOrderedSet using a HashSet and an ArrayList internally.
protected  ListOrderedSet(Set set)
     Constructor that wraps (not copies).
protected  ListOrderedSet(Set set, List list)
     Constructor that wraps (not copies) the Set and specifies the list to use.

Method Summary
public  booleanadd(Object object)
    
public  voidadd(int index, Object object)
    
public  booleanaddAll(Collection coll)
    
public  booleanaddAll(int index, Collection coll)
    
public  ListasList()
     Gets an unmodifiable view of the order of the Set.
public  voidclear()
    
public static  ListOrderedSetdecorate(Set set, List list)
     Factory method to create an ordered set specifying the list and set to use.
public static  ListOrderedSetdecorate(Set set)
     Factory method to create an ordered set.
public static  ListOrderedSetdecorate(List list)
     Factory method to create an ordered set using the supplied list to retain order.
public  Objectget(int index)
    
public  intindexOf(Object object)
    
public  Iteratoriterator()
    
public  booleanremove(Object object)
    
public  Objectremove(int index)
    
public  booleanremoveAll(Collection coll)
    
public  booleanretainAll(Collection coll)
    
public  Object[]toArray()
    
public  Object[]toArray(Object a)
    
public  StringtoString()
     Uses the underlying List's toString so that order is achieved.

Field Detail
setOrder
final protected List setOrder(Code)
Internal list to hold the sequence of objects




Constructor Detail
ListOrderedSet
public ListOrderedSet()(Code)
Constructs a new empty ListOrderedSet using a HashSet and an ArrayList internally.
since:
   Commons Collections 3.1



ListOrderedSet
protected ListOrderedSet(Set set)(Code)
Constructor that wraps (not copies).
Parameters:
  set - the set to decorate, must not be null
throws:
  IllegalArgumentException - if set is null



ListOrderedSet
protected ListOrderedSet(Set set, List list)(Code)
Constructor that wraps (not copies) the Set and specifies the list to use.

The set and list must both be correctly initialised to the same elements.
Parameters:
  set - the set to decorate, must not be null
Parameters:
  list - the list to decorate, must not be null
throws:
  IllegalArgumentException - if set or list is null





Method Detail
add
public boolean add(Object object)(Code)



add
public void add(int index, Object object)(Code)



addAll
public boolean addAll(Collection coll)(Code)



addAll
public boolean addAll(int index, Collection coll)(Code)



asList
public List asList()(Code)
Gets an unmodifiable view of the order of the Set. an unmodifiable list view



clear
public void clear()(Code)



decorate
public static ListOrderedSet decorate(Set set, List list)(Code)
Factory method to create an ordered set specifying the list and set to use.

The list and set must both be empty.
Parameters:
  set - the set to decorate, must be empty and not null
Parameters:
  list - the list to decorate, must be empty and not null
throws:
  IllegalArgumentException - if set or list is null
throws:
  IllegalArgumentException - if either the set or list is not empty
since:
   Commons Collections 3.1




decorate
public static ListOrderedSet decorate(Set set)(Code)
Factory method to create an ordered set.

An ArrayList is used to retain order.
Parameters:
  set - the set to decorate, must not be null
throws:
  IllegalArgumentException - if set is null




decorate
public static ListOrderedSet decorate(List list)(Code)
Factory method to create an ordered set using the supplied list to retain order.

A HashSet is used for the set behaviour.

NOTE: If the list contains duplicates, the duplicates are removed, altering the specified list.
Parameters:
  list - the list to decorate, must not be null
throws:
  IllegalArgumentException - if list is null




get
public Object get(int index)(Code)



indexOf
public int indexOf(Object object)(Code)



iterator
public Iterator iterator()(Code)



remove
public boolean remove(Object object)(Code)



remove
public Object remove(int index)(Code)



removeAll
public boolean removeAll(Collection coll)(Code)



retainAll
public boolean retainAll(Collection coll)(Code)



toArray
public Object[] toArray()(Code)



toArray
public Object[] toArray(Object a)(Code)



toString
public String toString()(Code)
Uses the underlying List's toString so that order is achieved. This means that the decorated Set's toString is not used, so any custom toStrings will be ignored.




Methods inherited from org.apache.commons.collections.set.AbstractSetDecorator
protected Set getSet()(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.