Java Doc for ListTool.java in  » Template-Engine » Velocity » org » apache » velocity » tools » generic » 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 » Template Engine » Velocity » org.apache.velocity.tools.generic 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.velocity.tools.generic.ListTool

ListTool
public class ListTool (Code)
Tool for working with Lists and arrays in Velocity templates. It provides a method to get and set specified elements. Also provides methods to perform the following actions to Lists and arrays:
  • Check if it is empty.
  • Check if it contains a certain element.

 Example uses:
 $primes                    -> new int[] {2, 3, 5, 7}
 $list.size($primes)        -> 4
 $list.get($primes, 2)      -> 5
 $list.set($primes, 2, 1)   -> (primes[2] becomes 1)
 $list.get($primes, 2)      -> 1
 $list.isEmpty($primes)     -> false
 $list.contains($primes, 7) -> true
 Example toolbox.xml config (if you want to use this with VelocityView):
 <tool>
 <key>list</key>
 <scope>application</scope>
 <class>org.apache.velocity.tools.generic.ListTool</class>
 </tool>
 

This tool is entirely threadsafe, and has no instance members. It may be used in any scope (request, session, or application).


author:
   Shinobu Kawai
version:
   $Id: $
since:
   VelocityTools 1.2



Constructor Summary
public  ListTool()
     Default constructor.

Method Summary
public  Booleancontains(Object list, Object element)
     Checks if a List/array contains a certain element.
Parameters:
  list - the List/array to check.
Parameters:
  element - the element to check.
public  Objectget(Object list, int index)
     Gets the specified element of a List/array. It will return null under the following conditions:
  • list is null.
  • list is not a List/array.
  • list doesn't have an indexth value.

Parameters:
  list - the List/array object.
Parameters:
  index - the index of the List/array to get.
public  booleanisArray(Object object)
     Checks if an object is an array.
Parameters:
  object - the object to check.
public  BooleanisEmpty(Object list)
     Checks if a List/array is empty.
Parameters:
  list - the List/array to check.
public  booleanisList(Object object)
     Checks if an object is a List.
Parameters:
  object - the object to check.
public  Objectset(Object list, int index, Object value)
     Sets the specified element of a List/array. It will return null under the following conditions:
  • list is null.
  • list is not a List/array.
  • list doesn't have an indexth value.

Parameters:
  list - the List/array object.
Parameters:
  index - the index of the List/array to set.
Parameters:
  value - the element to set.
public  Integersize(Object list)
     Gets the size of a List/array. It will return null under the following conditions:
  • list is null.
  • list is not a List/array.

Parameters:
  list - the List object.


Constructor Detail
ListTool
public ListTool()(Code)
Default constructor.




Method Detail
contains
public Boolean contains(Object list, Object element)(Code)
Checks if a List/array contains a certain element.
Parameters:
  list - the List/array to check.
Parameters:
  element - the element to check. true if the List/array contains the element.



get
public Object get(Object list, int index)(Code)
Gets the specified element of a List/array. It will return null under the following conditions:
  • list is null.
  • list is not a List/array.
  • list doesn't have an indexth value.

Parameters:
  list - the List/array object.
Parameters:
  index - the index of the List/array to get. the specified element of the List/array.



isArray
public boolean isArray(Object object)(Code)
Checks if an object is an array.
Parameters:
  object - the object to check. true if the object is an array.



isEmpty
public Boolean isEmpty(Object list)(Code)
Checks if a List/array is empty.
Parameters:
  list - the List/array to check. true if the List/array is empty.



isList
public boolean isList(Object object)(Code)
Checks if an object is a List.
Parameters:
  object - the object to check. true if the object is a List.



set
public Object set(Object list, int index, Object value)(Code)
Sets the specified element of a List/array. It will return null under the following conditions:
  • list is null.
  • list is not a List/array.
  • list doesn't have an indexth value.

Parameters:
  list - the List/array object.
Parameters:
  index - the index of the List/array to set.
Parameters:
  value - the element to set. blank if set, null if not set.



size
public Integer size(Object list)(Code)
Gets the size of a List/array. It will return null under the following conditions:
  • list is null.
  • list is not a List/array.

Parameters:
  list - the List object. the size of the List.



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.