Java Doc for EmailLink.java in  » Issue-Tracking » scarab-0.21 » org » tigris » scarab » util » 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 » Issue Tracking » scarab 0.21 » org.tigris.scarab.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.tigris.scarab.util.EmailLink

EmailLink
public class EmailLink implements InitableRecyclable,SkipFiltering(Code)

author:
   Jon S. Stevens
version:
   $Id: EmailLink.java 9476 2005-03-16 22:56:11Z dabbous $


Field Summary
final public static  StringHTTP
     HTTP protocol.
final public static  StringHTTPS
     HTTPS protocol.

Constructor Summary
public  EmailLink()
     Constructor to allow factory instantiation of EmailLinks.
public  EmailLink(Module currentModule)
     Constructor.

Method Summary
protected  voidaddPair(List list, String name, String value)
    
public  EmailLinkaddPathInfo(String name, String value)
     Adds a name=value pair to the path_info string.
public  EmailLinkaddPathInfo(String name, Object value)
     Adds a name=value pair to the path_info string.
public  EmailLinkaddPathInfo(String name, double value)
     Adds a name=value pair to the path_info string.
public  EmailLinkaddPathInfo(String name, int value)
     Adds a name=value pair to the path_info string.
public  EmailLinkaddPathInfo(String name, long value)
     Adds a name=value pair to the path_info string.
public  EmailLinkaddPathInfo(String name, boolean value)
     Adds a name=value pair to the path_info string.
public  voiddispose()
     Disposes the object by setting its disposed flag.
public  ModulegetCurrentModule()
    
public  EmailLinkgetIssueIdLink(Issue issue)
    
public  StringgetScriptName()
     Gets the server scriptName (/scarab/issues).
public  StringgetServerName()
     Gets the server name.
public  intgetServerPort()
     Gets the server port.
public  StringgetServerScheme()
     Gets the server scheme (HTTP or HTTPS).
public  booleanhasPathInfo()
     Does this URI have path info.
public  voidinit(Object obj)
    
public  booleanisDisposed()
     Checks whether the object is disposed.
public  EmailLinkomitModule()
     Causes the link to not include the module id.
public  voidrecycle()
     Recycles the object by removing its disposed flag.
public  voidrefresh()
    
protected  voidremovePairByName(List pairs, String name)
     Helper method to remove one or more pairs by its name (ie key).
public  voidremovePathInfo()
     Removes all the path info elements.
public  voidremovePathInfo(String name)
     Removes a name=value pair from the path info.
protected  StringrenderPairs(List pairs, char pairSep, char keyValSep)
     This method takes a List of key/value arrays and converts it into a URL encoded key/value pair format with the appropriate separator. a String to which the pairs are written to.
Parameters:
  pairs - A List of key/value arrays.
Parameters:
  pairSep - the character to use as a separator between pairs.For example for a query-like rendering it would be '&'.
Parameters:
  keyValSep - the character to use as a separator betweenkey and value.
protected  StringrenderPathInfo(List pairs)
     This method takes a Vector of key/value arrays and writes it to the supplied StringBuffer as encoded path info.
Parameters:
  pairs - A Vector of key/value arrays.
public  EmailLinksetAction(String action)
     Sets the action= value for this URL.

By default it adds the information to the path_info instead of the query data.
Parameters:
  action - A String with the action value.

public  voidsetCurrentModule(Module cM)
    
public  EmailLinksetPage(String t)
     Sets the template variable used by the Template Service.
public  EmailLinksetPathInfo(String key, String value)
    
public  StringtoString()
     Builds the URL with all of the data URL-encoded as well as encoded using HttpServletResponse.encodeUrl().

Field Detail
HTTP
final public static String HTTP(Code)
HTTP protocol.



HTTPS
final public static String HTTPS(Code)
HTTPS protocol.




Constructor Detail
EmailLink
public EmailLink()(Code)
Constructor to allow factory instantiation of EmailLinks. setCurrentModule must be called before first use.



EmailLink
public EmailLink(Module currentModule)(Code)
Constructor.




Method Detail
addPair
protected void addPair(List list, String name, String value)(Code)
Add a key value pair (in the form of a 2 object array) to the provided list
Parameters:
  list - List to add to.
Parameters:
  name - A String with the name to add.
Parameters:
  value - A String with the value to add.



addPathInfo
public EmailLink addPathInfo(String name, String value)(Code)
Adds a name=value pair to the path_info string.
Parameters:
  name - A String with the name to add.
Parameters:
  value - A String with the value to add.



addPathInfo
public EmailLink addPathInfo(String name, Object value)(Code)
Adds a name=value pair to the path_info string.
Parameters:
  name - A String with the name to add.
Parameters:
  value - An Object with the value to add.



addPathInfo
public EmailLink addPathInfo(String name, double value)(Code)
Adds a name=value pair to the path_info string.
Parameters:
  name - A String with the name to add.
Parameters:
  value - A double with the value to add.



addPathInfo
public EmailLink addPathInfo(String name, int value)(Code)
Adds a name=value pair to the path_info string.
Parameters:
  name - A String with the name to add.
Parameters:
  value - An int with the value to add.



addPathInfo
public EmailLink addPathInfo(String name, long value)(Code)
Adds a name=value pair to the path_info string.
Parameters:
  name - A String with the name to add.
Parameters:
  value - A long with the value to add.



addPathInfo
public EmailLink addPathInfo(String name, boolean value)(Code)
Adds a name=value pair to the path_info string.
Parameters:
  name - A String with the name to add.
Parameters:
  value - A double with the value to add.



dispose
public void dispose()(Code)
Disposes the object by setting its disposed flag.



getCurrentModule
public Module getCurrentModule()(Code)



getIssueIdLink
public EmailLink getIssueIdLink(Issue issue) throws Exception(Code)
Returns a short link for viewing a single issue
Parameters:
  issue - an Issue value a String value
exception:
  Exception - if an error occurs



getScriptName
public String getScriptName()(Code)
Gets the server scriptName (/scarab/issues). A String with the server scriptName.



getServerName
public String getServerName()(Code)
Gets the server name. A String with the server name.



getServerPort
public int getServerPort()(Code)
Gets the server port. A the server port, or -1 if unknown.



getServerScheme
public String getServerScheme()(Code)
Gets the server scheme (HTTP or HTTPS). A String with the server scheme.



hasPathInfo
public boolean hasPathInfo()(Code)
Does this URI have path info.



init
public void init(Object obj)(Code)



isDisposed
public boolean isDisposed()(Code)
Checks whether the object is disposed. true, if the object is disposed.



omitModule
public EmailLink omitModule()(Code)
Causes the link to not include the module id. Useful for templates where a module is not required or desired. a EmailLink value



recycle
public void recycle()(Code)
Recycles the object by removing its disposed flag.



refresh
public void refresh()(Code)



removePairByName
protected void removePairByName(List pairs, String name)(Code)
Helper method to remove one or more pairs by its name (ie key). It is intended to be used with queryData and pathInfo.
Parameters:
  pairs - the list of pairs to look over for removal.
Parameters:
  name - the name of the pair(s) to remove.



removePathInfo
public void removePathInfo()(Code)
Removes all the path info elements.



removePathInfo
public void removePathInfo(String name)(Code)
Removes a name=value pair from the path info.
Parameters:
  name - A String with the name to be removed.



renderPairs
protected String renderPairs(List pairs, char pairSep, char keyValSep)(Code)
This method takes a List of key/value arrays and converts it into a URL encoded key/value pair format with the appropriate separator. a String to which the pairs are written to.
Parameters:
  pairs - A List of key/value arrays.
Parameters:
  pairSep - the character to use as a separator between pairs.For example for a query-like rendering it would be '&'.
Parameters:
  keyValSep - the character to use as a separator betweenkey and value. For example for a query-like rendering, it would be '='.



renderPathInfo
protected String renderPathInfo(List pairs)(Code)
This method takes a Vector of key/value arrays and writes it to the supplied StringBuffer as encoded path info.
Parameters:
  pairs - A Vector of key/value arrays. a String to which encoded path info is written



setAction
public EmailLink setAction(String action)(Code)
Sets the action= value for this URL.

By default it adds the information to the path_info instead of the query data.
Parameters:
  action - A String with the action value. A EmailLink (self).




setCurrentModule
public void setCurrentModule(Module cM)(Code)



setPage
public EmailLink setPage(String t)(Code)
Sets the template variable used by the Template Service. The module id of the new selected module is given.
Parameters:
  t - A String with the template name. A EmailLink.



setPathInfo
public EmailLink setPathInfo(String key, String value)(Code)



toString
public String toString()(Code)
Builds the URL with all of the data URL-encoded as well as encoded using HttpServletResponse.encodeUrl().

 DynamicURI dui = new DynamicURI (data, "UserScreen" );
 dui.addPathInfo("user","jon");
 dui.toString();
 
The above call to toString() would return the String:

http://www.server.com/servlets/Turbine/screen/UserScreen/user/jon A String with the built URL.




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.