Java Doc for ArgumentCompletor.java in  » Development » jLine » jline » 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 » Development » jLine » jline 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   jline.ArgumentCompletor

ArgumentCompletor
public class ArgumentCompletor implements Completor(Code)
A Completor implementation that invokes a child completor using the appropriate separator argument. This can be used instead of the individual completors having to know about argument parsing semantics.

Example 1: Any argument of the command line can use file completion.

 consoleReader.addCompletor (new ArgumentCompletor (
 new 
FileNameCompletor  ()))
 

Example 2: The first argument of the command line can be completed with any of "foo", "bar", or "baz", and remaining arguments can be completed with a file name.

 consoleReader.addCompletor (new ArgumentCompletor (
 new 
SimpleCompletor  (new String [] { "foo", "bar", "baz"})));
 consoleReader.addCompletor (new ArgumentCompletor (
 new 
FileNameCompletor  ()));
 

When the argument index is past the last embedded completors, the last completors is always used. To disable this behavior, have the last completor be a NullCompletor . For example:

 consoleReader.addCompletor (new ArgumentCompletor (
 new 
SimpleCompletor  (new String [] { "foo", "bar", "baz"}),
 new 
SimpleCompletor  (new String [] { "xxx", "yyy", "xxx"}),
 new 
NullCompletor ));
 

TODO: handle argument quoting and escape characters


author:
   Marc Prud'hommeaux

Inner Class :public static interface ArgumentDelimiter
Inner Class :abstract public static class AbstractArgumentDelimiter implements ArgumentDelimiter
Inner Class :public static class WhitespaceArgumentDelimiter extends AbstractArgumentDelimiter
Inner Class :public static class ArgumentList

Field Summary
final  Completor[]completors
    
final  ArgumentDelimiterdelim
    
 booleanstrict
    

Constructor Summary
public  ArgumentCompletor(Completor completor)
     Constuctor: create a new completor with the default argument separator of " ".
public  ArgumentCompletor(List completors)
     Constuctor: create a new completor with the default argument separator of " ".
public  ArgumentCompletor(Completor[] completors)
     Constuctor: create a new completor with the default argument separator of " ".
public  ArgumentCompletor(Completor completor, ArgumentDelimiter delim)
     Constuctor: create a new completor with the specified argument delimiter.
public  ArgumentCompletor(Completor[] completors, ArgumentDelimiter delim)
     Constuctor: create a new completor with the specified argument delimiter.

Method Summary
public  intcomplete(String buffer, int cursor, List candidates)
    
public  booleangetStrict()
     Returns whether a completion at argument index N will succees if all the completions from arguments 0-(N-1) also succeed.
public  voidsetStrict(boolean strict)
     If true, a completion at argument index N will only succeed if all the completions from 0-(N-1) also succeed.

Field Detail
completors
final Completor[] completors(Code)



delim
final ArgumentDelimiter delim(Code)



strict
boolean strict(Code)




Constructor Detail
ArgumentCompletor
public ArgumentCompletor(Completor completor)(Code)
Constuctor: create a new completor with the default argument separator of " ".
Parameters:
  completor - the embedded completor



ArgumentCompletor
public ArgumentCompletor(List completors)(Code)
Constuctor: create a new completor with the default argument separator of " ".
Parameters:
  completors - the List of completors to use



ArgumentCompletor
public ArgumentCompletor(Completor[] completors)(Code)
Constuctor: create a new completor with the default argument separator of " ".
Parameters:
  completors - the embedded argument completors



ArgumentCompletor
public ArgumentCompletor(Completor completor, ArgumentDelimiter delim)(Code)
Constuctor: create a new completor with the specified argument delimiter.
Parameters:
  completor - the embedded completor
Parameters:
  delim - the delimiter for parsing arguments



ArgumentCompletor
public ArgumentCompletor(Completor[] completors, ArgumentDelimiter delim)(Code)
Constuctor: create a new completor with the specified argument delimiter.
Parameters:
  completors - the embedded completors
Parameters:
  delim - the delimiter for parsing arguments




Method Detail
complete
public int complete(String buffer, int cursor, List candidates)(Code)



getStrict
public boolean getStrict()(Code)
Returns whether a completion at argument index N will succees if all the completions from arguments 0-(N-1) also succeed.



setStrict
public void setStrict(boolean strict)(Code)
If true, a completion at argument index N will only succeed if all the completions from 0-(N-1) also succeed.



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.