Java Doc for HeaderElement.java in  » Net » Apache-common-HttpClient » org » apache » commons » httpclient » 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 » Net » Apache common HttpClient » org.apache.commons.httpclient 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.httpclient.NameValuePair
      org.apache.commons.httpclient.HeaderElement

HeaderElement
public class HeaderElement extends NameValuePair (Code)

One element of an HTTP header's value.

Some HTTP headers (such as the set-cookie header) have values that can be decomposed into multiple elements. Such headers must be in the following form:

 header  = [ element ] *( "," [ element ] )
 element = name [ "=" [ value ] ] *( ";" [ param ] )
 param   = name [ "=" [ value ] ]
 name    = token
 value   = ( token | quoted-string )
 token         = 1*<any char except "=", ",", ";", <"> and
 white space>
 quoted-string = <"> *( text | quoted-char ) <">
 text          = any char except <">
 quoted-char   = "\" char
 

Any amount of white space is allowed between any part of the header, element or param and is ignored. A missing value in any element or param will be stored as the empty String ; if the "=" is also missing null will be stored instead.

This class represents an individual header element, containing both a name/value pair (value may be null) and optionally a set of additional parameters.

This class also exposes a HeaderElement.parse method for parsing a Header value into an array of elements.


See Also:   Header
author:
   B.C. Holmes
author:
   Park, Sung-Gu
author:
   Mike Bowler
author:
   Oleg Kalnichevski
since:
   1.0
version:
   $Revision: 480424 $ $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $



Constructor Summary
public  HeaderElement()
     Default constructor.
public  HeaderElement(String name, String value)
     Constructor.
public  HeaderElement(String name, String value, NameValuePair[] parameters)
     Constructor with name, value and parameters.
public  HeaderElement(char[] chars, int offset, int length)
     Constructor with array of characters.
public  HeaderElement(char[] chars)
     Constructor with array of characters.

Method Summary
public  NameValuePairgetParameterByName(String name)
     Returns parameter with the given name, if found.
public  NameValuePair[]getParameters()
     Get parameters, if any.
final public static  HeaderElement[]parse(String headerValue)
     This parses the value part of a header.
final public static  HeaderElement[]parseElements(char[] headerValue)
     This parses the value part of a header.
final public static  HeaderElement[]parseElements(String headerValue)
     This parses the value part of a header.


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



HeaderElement
public HeaderElement(String name, String value)(Code)
Constructor.
Parameters:
  name - my name
Parameters:
  value - my (possibly null) value



HeaderElement
public HeaderElement(String name, String value, NameValuePair[] parameters)(Code)
Constructor with name, value and parameters.
Parameters:
  name - my name
Parameters:
  value - my (possibly null) value
Parameters:
  parameters - my (possibly null) parameters



HeaderElement
public HeaderElement(char[] chars, int offset, int length)(Code)
Constructor with array of characters.
Parameters:
  chars - the array of characters
Parameters:
  offset - - the initial offset.
Parameters:
  length - - the length.
since:
   3.0



HeaderElement
public HeaderElement(char[] chars)(Code)
Constructor with array of characters.
Parameters:
  chars - the array of characters
since:
   3.0




Method Detail
getParameterByName
public NameValuePair getParameterByName(String name)(Code)
Returns parameter with the given name, if found. Otherwise null is returned
Parameters:
  name - The name to search by. NameValuePair parameter with the given name



getParameters
public NameValuePair[] getParameters()(Code)
Get parameters, if any.
since:
   2.0 parameters as an array of NameValuePairs



parse
final public static HeaderElement[] parse(String headerValue) throws HttpException(Code)
This parses the value part of a header. The result is an array of HeaderElement objects.
Parameters:
  headerValue - the string representation of the header value(as received from the web server). array of HeaderElements.
throws:
  HttpException - if the above syntax rules are violated.



parseElements
final public static HeaderElement[] parseElements(char[] headerValue)(Code)
This parses the value part of a header. The result is an array of HeaderElement objects.
Parameters:
  headerValue - the array of char representation of the header value(as received from the web server). array of HeaderElements.
since:
   3.0



parseElements
final public static HeaderElement[] parseElements(String headerValue)(Code)
This parses the value part of a header. The result is an array of HeaderElement objects.
Parameters:
  headerValue - the string representation of the header value(as received from the web server). array of HeaderElements.
since:
   3.0



Methods inherited from org.apache.commons.httpclient.NameValuePair
public boolean equals(Object object)(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public String getValue()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setValue(String value)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

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.