Java Doc for ArrayTool.java in  » Blogger-System » blojsom-3.1 » 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 » Blogger System » blojsom 3.1 » org.apache.velocity.tools.generic 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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

ArrayTool
public class ArrayTool (Code)
Tool for working with arrays in Velocity templates. It provides a method to get and set specified elements, retrieve the length, and create clones of an array object. Also provides a method to convert arrays into java.util.List's.

 Example uses:
 $primes                   -> new int[] {2, 3, 5, 7}
 $array.length($primes)    -> 4
 $array.get($primes, 2)    -> 5
 $array.clone($primes)     -> int[] {2, 3, 5, 7}, != $primes
 $array.set($primes, 2, 1) -> (primes[2] becomes 1)
 $array.get($primes, 2)    -> 1
 $array.get($clone, 2)     -> 5
 

Example toolbox.xml config (if you want to use this with VelocityView): <tool> <key>array</key> <scope>application</scope> <class>org.apache.velocity.tools.generic.ArrayTool</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



Constructor Summary
public  ArrayTool()
     Default constructor.

Method Summary
public  Objectclone(Object array)
     Gets the clone of an array. It will return null under the following conditions:
  • array is null.
  • array is not an array.

Parameters:
  array - the array object.
public  Objectget(Object array, int index)
     Gets the specified element of an array. It will return null under the following conditions:
  • array is null.
  • array is not an array.
  • array doesn't have an indexth value.

Parameters:
  array - the array object.
Parameters:
  index - the index of the array to get.
public  booleanisArray(Object object)
     Checks if an object is an array.
Parameters:
  object - the object to check.
public  Integerlength(Object array)
     Gets the length of an array. It will return null under the following conditions:
  • array is null.
  • array is not an array.

Parameters:
  array - the array object.
public  Listlist(Object array)
     Converts an array object into a java.util.List.
  • If the object is an array of an Object, it will return a java.util.List of the elements.
  • If the object is an array of a primitive type, it will return a java.util.List of the elements wrapped in their wrapper class.
  • If the object is none of the above, it will return null.

Parameters:
  array - an array object.
public  Objectset(Object array, int index, Object value)
     Sets the specified element of an array.


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




Method Detail
clone
public Object clone(Object array)(Code)
Gets the clone of an array. It will return null under the following conditions:
  • array is null.
  • array is not an array.

Parameters:
  array - the array object. the clone of the array.



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

Parameters:
  array - the array object.
Parameters:
  index - the index of the array to get. the specified element of the 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.



length
public Integer length(Object array)(Code)
Gets the length of an array. It will return null under the following conditions:
  • array is null.
  • array is not an array.

Parameters:
  array - the array object. the length of the array.



list
public List list(Object array)(Code)
Converts an array object into a java.util.List.
  • If the object is an array of an Object, it will return a java.util.List of the elements.
  • If the object is an array of a primitive type, it will return a java.util.List of the elements wrapped in their wrapper class.
  • If the object is none of the above, it will return null.

Parameters:
  array - an array object. the converted java.util.List.



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

Parameters:
  array - the array object.
Parameters:
  index - the index of the array to set.
Parameters:
  value - the element to set.



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.