Java Doc for AttributesOutputSegment.java in  » HTML-Parser » jericho-html » au » id » jericho » lib » html » 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 » HTML Parser » jericho html » au.id.jericho.lib.html 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   au.id.jericho.lib.html.AttributesOutputSegment

AttributesOutputSegment
class AttributesOutputSegment implements OutputSegment(Code)
Implements an OutputSegment whose content is a list of attribute name/value pairs.

This output segment is designed to replace the original Attributes segment in the source, providing a simple means of adding, modifying and removing attributes.

Each instance of this class contains a java.util.Map of name/value pairs which can either be specified directly in the constructor or initialised to the same entries as the source Attributes specified in the constructor. This map can be accessed via the AttributesOutputSegment.getMap() method, and its entries modified as required before output.

Keys in the map must be String objects, and values must implement the CharSequence interface.

An attribute with no value is represented by a map entry with a null value.

Attribute values are stored unencoded in the map, and are automatically if necessary during output.

The use of invalid characters in attribute names results in unspecified behaviour.

Note that methods in the Attributes class treat attribute names as case insensitive, whereas the Map treats them as case sensitive.

Example of Usage:

 Source source=new Source(htmlDocument);
 Attributes bodyAttributes
 =source.findNextStartTag(0,Tag.BODY).getAttributes();
 AttributesOutputSegment bodyAttributesOutputSegment
 =new AttributesOutputSegment(bodyAttributes,true);
 bodyAttributesOutputSegment.getMap().put("bgcolor","green");
 OutputDocument outputDocument=new OutputDocument(source);
 outputDocument.register(bodyAttributesOutputSegment);
 String htmlDocumentWithGreenBackground=outputDocument.toString();
 

This class has been removed from the public API and the functionality replaced with the OutputDocument.replace(AttributesMap) and OutputDocument#replace(Attributes, boolean convertNamesToLowerCase) methods.
See Also:   OutputDocument
See Also:   Attributes




Constructor Summary
public  AttributesOutputSegment(Attributes attributes, boolean convertNamesToLowerCase)
     Constructs a new AttributesOutputSegment with the same span and initial name/value entries as the specified source Attributes .
public  AttributesOutputSegment(Attributes attributes, Map map)
     Constructs a new AttributesOutputSegment with the same span as the specified source Attributes , using the specified Map to store the entries.

Method Summary
public  intgetBegin()
    
public  StringgetDebugInfo()
    
public  intgetEnd()
    
public  longgetEstimatedMaximumOutputLength()
    
public  MapgetMap()
     Returns the Map containing the name/value entries to be output.
public  StringtoString()
    
public  voidwriteTo(Writer writer)
     Writes the contents of the as HTML attribute name/value pairs to the specified Writer.


Constructor Detail
AttributesOutputSegment
public AttributesOutputSegment(Attributes attributes, boolean convertNamesToLowerCase)(Code)
Constructs a new AttributesOutputSegment with the same span and initial name/value entries as the specified source Attributes .

Specifying a value of true as an argument to the convertNamesToLowerCase parameter causes all attribute names to be converted to lower case in the map. This simplifies the process of finding/updating specific attributes since map keys are case sensitive.

Attribute values are automatically before being loaded into the map.

Calling this constructor with the following code:

new AttributesOutputSegment(attributes, convertNamesToLowerCase)
is logically equivalent to calling:
new AttributesOutputSegment(attributes, attributes.populateMap(new LinkedHashMap(), convertNamesToLowerCase))

The use of LinkedHashMap to implement the map ensures (probably unnecessarily) that existing attributes are output in the same order as they appear in the source document, and new attributes are output in the same order as they are added.
Parameters:
  attributes - the Attributes defining the span and initial name/value entries of the new AttributesOutputSegment.
Parameters:
  convertNamesToLowerCase - specifies whether all attribute names are converted to lower case in the map.
See Also:   AttributesOutputSegment.AttributesOutputSegment(Attributes,Map)




AttributesOutputSegment
public AttributesOutputSegment(Attributes attributes, Map map)(Code)
Constructs a new AttributesOutputSegment with the same span as the specified source Attributes , using the specified Map to store the entries.

This constructor might be used if the Map containing the new attribute values should not be preloaded with the same entries as the source attributes, or a map implementation other than LinkedHashMap is required.
Parameters:
  attributes - the Attributes defining the span of the new AttributesOutputSegment.
Parameters:
  map - the Map containing the name/value entries.
See Also:    #AttributesOutputSegment(Attributes, boolean convertNamesToLowerCase)





Method Detail
getBegin
public int getBegin()(Code)



getDebugInfo
public String getDebugInfo()(Code)



getEnd
public int getEnd()(Code)



getEstimatedMaximumOutputLength
public long getEstimatedMaximumOutputLength()(Code)



getMap
public Map getMap()(Code)
Returns the Map containing the name/value entries to be output. the Map containing the name/value entries to be output.



toString
public String toString()(Code)



writeTo
public void writeTo(Writer writer) throws IOException(Code)
Writes the contents of the as HTML attribute name/value pairs to the specified Writer.

Each attribute is preceded by a single space, and all values are and enclosed in double quotes.
Parameters:
  writer - the destination java.io.Writer for the output.
throws:
  IOException - if an I/O exception occurs.
See Also:   Attributes.generateHTML(Map attributesMap)




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.